Move documentation index to sidebar and remove from bottoms of pages #19460
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
While our online documentation index is a bit overwhelmingly large and badly formatted, it still seems useful, but difficult to discover by not being on our docs sidebar. This PR moves it there and removes it from other places it was mentioned. It turns out that because of the way the index is generated by Sphinx, it's not trivial to get it onto the sidebar, which is why I think it was not there before, and was instead at the bottom of several module-based pages. Here, I took a tip from https://stackoverflow.com/questions/25243482/how-to-add-sphinx-generated-index-to-the-sidebar-when-using-read-the-docs-theme and wedged it in there, though to make it look proper on the web and in the generated HTML, I had to embed more HTML than that solution included. I removed it from the bottoms of the other pages because it seemed unnecessary (it's not specific to those pages in any way) and clutter-y. --- Signed-off-by: Brad Chamberlain <bradcray@users.noreply.github.com>
lydia-duncan
approved these changes
Mar 17, 2022
|
I like that this displays the index more prominently and that you can get to it from anywhere now. 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While our online documentation index is a bit overwhelmingly large and
badly formatted, it still seems useful, but difficult to discover by
not being on our docs sidebar. This PR moves it there and removes it
from other places it was mentioned.
It turns out that because of the way the index is generated by Sphinx,
it's not trivial to get it onto the sidebar, which is why I think it
was not there before, and was instead at the bottom of several
module-based pages. Here, I took a tip from
https://stackoverflow.com/questions/25243482/how-to-add-sphinx-generated-index-to-the-sidebar-when-using-read-the-docs-theme
and wedged it in there, though to make it look proper on the web and
in the generated HTML, I had to embed more HTML than that solution
included.
I removed it from the bottoms of the other pages because it seemed
unnecessary (it's not specific to those pages in any way) and
clutter-y.