doc: factor out quick install tab for reuse #30451
Conversation
400de8d to
b1697f7
Compare
There was a problem hiding this comment.
I see no compelling reason that there should be an "other" tab in one place but not the others.
IMHO the toctree is misplaced in the other tab. Assuming we formally need a toctree on doc/index.rst we should put it below the tabs and make it :hidden:. The Link "For more detailed instructions, see the installation guide." goes to the top of the page that is toctreed, which is good enough. People don't need the subsections on the doc/index.rst entry page.
We can then decide whether we drop the "other" tab completely or just keep links to "other" installation methods, which is a subset of the current toctree, e.g.
But overall this is already an improvement, so I'll leave it up to you whether you want to do the additional modifications or just merge as is.
I like this suggestion so I'll try to implement it tomorrow. |
|
Made changes, threw "for more detailed instructions see" into bottom of tab set page (that then opted out of for install guide) b/c usually want both.
|
eac8178 to
503a491
Compare
doc/install/quick_install.inc.rst
Outdated
|
|
||
| .. end tab-set | ||
|
|
||
| For more detailed instructions, see the :doc:`installation guide </install/index>`. |
There was a problem hiding this comment.
I would leave out this sentence here and instead copy it to the two places where it's needed. This will remove the need for :end-before:, which IMHO makes inclusions harder to understand and more brittle.
Also note: If we follow my proposal from #29775 (comment), https://matplotlib.org/stable/users/getting_started/ will be removed, so that we may have just one location for this sentence in the future.
There was a problem hiding this comment.
The sentence /tab set will probably get moved to the user guide quick start guide if it gets blended but changed it b/c it's not that big of a deal.
file and added tab set to getting started guide
|
@meeseeksdev backport to v3.10.5-doc |
|
@meeseeksdev backport to v3.10.x |
…451-on-v3.10.5-doc Backport PR #30451 on branch v3.10.5-doc (doc: factor out quick install tab for reuse)
…451-on-v3.10.x Backport PR #30451 on branch v3.10.x (doc: factor out quick install tab for reuse)
PR summary
This PR puts the tab set of install instructions into a stand alone file that's then included on the index, install/index, and getting started pages. The motivation is ensuring consistent quick install instructions across the docs.
The end line is to exclude the toc-tree, but I don't know how to comment that w/o breaking the build.xref: #29775
PR checklist