-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
DOC: more site re-org #21251
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
DOC: more site re-org #21251
Conversation
26fcdef
to
7eb99af
Compare
Build failed but the uploaded docs are mostly correct |
Moving the discussion from #21224 (comment) to here.
Makes sense.
I think the folder structure here dictates the url structure in the final docs. Having In theory the main sections in https://63987-1385122-gh.circle-artifacts.com/0/doc/build/html/users/index.html should correspond to top-level file structure elements; single files like |
OK, I've persisted here in keeping |
6ad7043
to
06b725c
Compare
899feec
to
9b9dfae
Compare
nit: under install |
Thanks @story645 - that is what is in the current Installing guide, so I was just copying verbatim. I've tried to keep editorial changes out of this PR because it touches so much of the website we'd be quite a while fixing everything! |
I can make it it's own PR then... |
@timhoffm @tacaswell not quite sure if se decided to move all the rst up a level or not. I think that would be
I'd still prefer the Navbar links linked to |
9b9dfae
to
2d53d22
Compare
2466d25
to
4747e4a
Compare
The root of the index is users/index Most material is now under users/
1b949af
to
ccdffe7
Compare
This is a link to the new TOC of |
…251-on-v3.5.x Backport PR #21251 on branch v3.5.x (DOC: more site re-org)
This file was removed in #21251
This file was removed in matplotlib#21251
This file was removed in matplotlib#21251
This file was removed in matplotlib#21251
This came in via matplotlib#21251 and I vaguely remember it had a purpose (possibly something with navigation / what is rendered in the sidebars?) However, in the current docs, it looks rather useless. https://matplotlib.org/devdocs/users/release_notes.html
Attempt to remove duplicated info in /users/index.html and /contents.html
The root of the index is users/index
Most material is now under users/
Proposed top-level org
The only rst file at the
/doc
level is/doc/index.rst
The rest are organized underusers
.Old users tree
New users tree:
Note
backmatter
,faq
,explain
, andinstalling
used to have top-level rst files, that then indexed two or more subfiles. Those have been moved down into users as subdirectories and renamed eginstalling.rst
->users/installing/index.rst