Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Duplicate sections in the documentation site #1204

Open
ZviBaratz opened this issue Feb 18, 2023 · 3 comments · May be fixed by #1205
Open

Duplicate sections in the documentation site #1204

ZviBaratz opened this issue Feb 18, 2023 · 3 comments · May be fixed by #1205

Comments

@ZviBaratz
Copy link
Contributor

ZviBaratz commented Feb 18, 2023

The README update in #1195 included an installation section which wasn't there before and creates a redundancy in the documentation site.
Looking at the download and installation instructions page, my impression is that it might be possible to remove that page altogether. There might be a couple of bits which could be ported to other locations, but nothing crucial. WDYT?

@ZviBaratz ZviBaratz changed the title Duplicate installation section in the documentation site Duplicate sections in the documentation site Feb 18, 2023
@ZviBaratz
Copy link
Contributor Author

Actually, the "License" and "License reprise" sections, as well as the "Mailing list" and "Support" sections, also seem redundant. Definitely seems like they should be merged.

@ZviBaratz
Copy link
Contributor Author

@matthew-brett @effigies do you agree the download and installation page in the docs isn't really required anymore? Are there any particular parts of it you would like to see ported to the README?

@effigies
Copy link
Member

I actually think the detailed download and installation page is useful as it goes into alternatives to pip, such as NeuroDebian, and mentions how to get pip and that we recommend using virtual environments. I would suggest that we remove this section:

Download and Installation
=========================
Please find detailed :ref:`download and installation instructions
<installation>` in the manual.

And add that line to the long description/README. (We'll need to add a link in the README.rst header so <installation> resolves to the docs.

I believe the point of the license reprise is so that it could have links that render correctly within the docs. If we do the same and add rendering links to the header of README, we could remove the second. Similarly, I think just replacing the mailing list section in the README with the section from index.rst would be good.

@ZviBaratz ZviBaratz linked a pull request Feb 21, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants