search

NGEET / fates-users-guide

User and Developer's Guide for the FATES model
1 stars 5 forks source link

Implement the use of robotpy-sphinx-plugin to access sidebar generate function #1

Closed glemieux closed 2 years ago

glemieux commented 2 years ago

We should have a link to the FATES technical document subproject in the sidebar of the User's Guide. Currently the sidebar only displays the information in the sidebar on the index page due to limitations in readthedocs and sphinx. This is because sphinx doesn't support intersphinx in toctrees (see https://github.com/sphinx-doc/sphinx/issues/1836) and readthedocs doesn't support displaying subprojects in the sidebar of the default theme (see https://github.com/readthedocs/readthedocs.org/issues/2588). Reading through the linked issues mentioned I found that the robotpy project documentation built a python function to generate the side bar to enable this capability: https://github.com/robotpy/robotpy-sphinx-plugin. We should give implementing this a try.

glemieux commented 2 years ago

Interestingly, the link to the fates technical documentation seems to be showing up in the sidebar even if you move away from the index page now.