Branch: refs/heads/main
Revision: 1338830
Author: bradcray
Link: Move documentation index to sidebar and remove from bottoms of pages by bradcray · Pull Request #19460 · chapel-lang/chapel · GitHub
Log Message:
Merge pull request #19460 from bradcray/index-on-sidebar
Move documentation index to sidebar and remove from bottoms of pages
[reviewed by @lydia-duncan]
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
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.
Modified Files:
M doc/rst/meta/modules/layoutdist.rst
M doc/rst/meta/modules/packages.rst
M doc/rst/meta/modules/standard.rst
M doc/rst/meta/templates/layout.html
Compare: https://github.com/chapel-lang/chapel/compare/202aec56c6b7...133883026db4