Skip to content

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

Merged
merged 8 commits into from
Oct 21, 2021
Merged

DOC: more site re-org #21251

merged 8 commits into from
Oct 21, 2021

Conversation

jklymak
Copy link
Member

@jklymak jklymak commented Oct 1, 2021

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

├── _static
├── _templates
├── api
├── devel
├── gallery
├── plot_types
├── thirdpartypackages
├── tutorials
└── users

The only rst file at the /doc level is /doc/index.rst The rest are organized under users.

Old users tree

├── faq
└── users
    ├── installing
    ├── next_whats_new
    └── prev_whats_new

New users tree:

── users
    ├── backmatter
    ├── explain
    ├── faq
    ├── installing
    ├── next_whats_new
    ├── prev_whats_new
    └── resources

Note backmatter, faq, explain, and installing 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 eg installing.rst->users/installing/index.rst

@jklymak
Copy link
Member Author

jklymak commented Oct 1, 2021

Build failed but the uploaded docs are mostly correct

@timhoffm
Copy link
Member

timhoffm commented Oct 1, 2021

Moving the discussion from #21224 (comment) to here.

BTW, I'm open to inverting #21251 and moving all the references to /contents.html and getting rid of /users/index.html.

Makes sense.

We could probably just rename /users -> /miscellaneous which is what is in that directory now.

I think the folder structure here dictates the url structure in the final docs. Having miscellaneous/installing.html is a bit weird. Maybe we have to move documents around as well.

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 ressources (if there is only one file containing the whole section) or folders like gallery.

@jklymak
Copy link
Member Author

jklymak commented Oct 2, 2021

OK, I've persisted here in keeping /users/index.html as the top-level TOC. We could bubble it up a level, but I really prefer the tree with /doc/gallery, /doc/tutorials, /doc/api, /doc/users as the only top-level subdirectories. Basically /doc/users is the rst-based docs, appropriately sorted, and the other three are auto-generated. (The exceptions are the development guide and thridparty, both of which will be hosted separately).

@jklymak jklymak marked this pull request as ready for review October 2, 2021 15:01
@jklymak jklymak force-pushed the doc-more-reorg branch 2 times, most recently from 899feec to 9b9dfae Compare October 2, 2021 16:06
@story645
Copy link
Member

story645 commented Oct 7, 2021

nit: under install Third-party distributions is I think mpl specific jargon, what about package manager or Installing using a package manager

@jklymak
Copy link
Member Author

jklymak commented Oct 7, 2021

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!

@story645
Copy link
Member

story645 commented Oct 7, 2021

I can make it it's own PR then...

@jklymak
Copy link
Member Author

jklymak commented Oct 8, 2021

@timhoffm @tacaswell not quite sure if se decided to move all the rst up a level or not. I think that would be

- doc/
  - backmatter
   - explain
   - faq
   - installing
   - next_whats_new
   - prev_whats_new
   - resources  
   - tutorials
   - examples
   - plot_types
   - api
   - thirdparty 
   - devel
   
   - index.html (current docs top page)
   - contents.html (what is currently users/index.html

I'd still prefer the Navbar links linked to topic/index.html if possible, but ..

@jklymak
Copy link
Member Author

jklymak commented Oct 21, 2021

This is a link to the new TOC of users/: https://64359-1385122-gh.circle-artifacts.com/0/doc/build/html/users/index.html#

@jklymak jklymak marked this pull request as ready for review October 21, 2021 10:39
@tacaswell tacaswell added this to the v3.5.0 milestone Oct 21, 2021
@tacaswell tacaswell merged commit b2422b0 into matplotlib:main Oct 21, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Oct 21, 2021
tacaswell added a commit that referenced this pull request Oct 21, 2021
…251-on-v3.5.x

Backport PR #21251 on branch v3.5.x (DOC: more site re-org)
@jklymak jklymak deleted the doc-more-reorg branch October 22, 2021 09:19
QuLogic added a commit that referenced this pull request Nov 17, 2021
This file was removed in #21251
@QuLogic QuLogic mentioned this pull request Nov 17, 2021
2 tasks
QuLogic added a commit to QuLogic/matplotlib that referenced this pull request Nov 18, 2021
QuLogic added a commit to QuLogic/matplotlib that referenced this pull request Nov 23, 2021
QuLogic added a commit to QuLogic/matplotlib that referenced this pull request Nov 26, 2021
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Jan 23, 2024
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants