Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
tacaswell merged 8 commits intomatplotlib:mainfromjklymak:doc-more-reorg
Oct 21, 2021
Merged

Conversation

jklymak
Copy link
Member

@jklymakjklymak commentedOct 1, 2021•
edited
Loading

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 underusers.

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

Notebackmatter,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

@jklymak
Copy link
MemberAuthor

Build failed but the uploaded docs are mostly correct

@timhoffm
Copy link
Member

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. Havingmiscellaneous/installing.html is a bit weird. Maybe we have to move documents around as well.

In theory the main sections inhttps://63987-1385122-gh.circle-artifacts.com/0/doc/build/html/users/index.html should correspond to top-level file structure elements; single files likeressources (if there is only one file containing the whole section) or folders likegallery.

@jklymak
Copy link
MemberAuthor

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).

@jklymakjklymak marked this pull request as ready for reviewOctober 2, 2021 15:01
@jklymakjklymakforce-pushed thedoc-more-reorg branch 2 times, most recently from899feec to9b9dfaeCompareOctober 2, 2021 16:06
@story645
Copy link
Member

nit: under installThird-party distributions is I think mpl specific jargon, what aboutpackage manager orInstalling using a package manager

@jklymak
Copy link
MemberAuthor

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 reacted with thumbs up emoji

@story645
Copy link
Member

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

jklymak reacted with thumbs up emoji

@jklymak
Copy link
MemberAuthor

@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 totopic/index.html if possible, but ..

@jklymak
Copy link
MemberAuthor

@jklymakjklymak marked this pull request as ready for reviewOctober 21, 2021 10:39
@tacaswelltacaswell added this to thev3.5.0 milestoneOct 21, 2021
@tacaswelltacaswell merged commitb2422b0 intomatplotlib:mainOct 21, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestOct 21, 2021
tacaswell added a commit that referenced this pull requestOct 21, 2021
…251-on-v3.5.xBackport PR#21251 on branch v3.5.x (DOC: more site re-org)
@jklymakjklymak deleted the doc-more-reorg branchOctober 22, 2021 09:19
QuLogic added a commit that referenced this pull requestNov 17, 2021
@QuLogicQuLogic mentioned this pull requestNov 17, 2021
2 tasks
QuLogic added a commit to QuLogic/matplotlib that referenced this pull requestNov 18, 2021
QuLogic added a commit to QuLogic/matplotlib that referenced this pull requestNov 23, 2021
QuLogic added a commit to QuLogic/matplotlib that referenced this pull requestNov 26, 2021
timhoffm added a commit to timhoffm/matplotlib that referenced this pull requestJan 23, 2024
This came in viamatplotlib#21251 and I vaguely remember it hada purpose (possibly something with navigation / whatis rendered in the sidebars?) However, in thecurrent docs, it looks rather useless.https://matplotlib.org/devdocs/users/release_notes.html
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@tacaswelltacaswelltacaswell approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.5.0
Development

Successfully merging this pull request may close these issues.

4 participants
@jklymak@timhoffm@story645@tacaswell
[8]ページ先頭
©2009-2025 Movatter.jp