-
Notifications
You must be signed in to change notification settings - Fork 25
Description
I'd like to propose the following:
-
Switch from using
sphinxcontrib-versioningtosphinx-multiversionas discussed in sphinx-multiversion to replace sphinxcontrib-versioning? #209. -
Stop using
nbsphinxto generate doc files directly from notebooks. We are not really using this currently anyway, and rebuilding some of the old docs is now failing because, for example, there used to be adoc/pyclaw/tutorials/burgers/pyclaw_tutorial.ipynbfile that no longer exists, but when trying to buildv5.3.1, for example, it tries to runnbconverton this notebook, which fails since this doesn't run with the current clawpack.Using
nbsphinxalso means making the docs is slow if it has to do this for all past versions each time.I think the more robust system, which I've already been using, is to keep the tutorial notebooks we want in
$CLAW/apps/notebooksand use the script gallery/notebooks/make_html_from_notebooks.py to convert them to html version in the gallery of notebooks. -
Stop using
intersphinxto link to specific gallery pages from the main docs. This is very lightly used and often doesn't seem to work right anyway. Since we're not versioning the gallery and it's just a static set of pages, I think from the main docs we can just like to a specific page like http://www.clawpack.org/gallery/notebooks.html where desired.
I've been having problems recently with sphinx getting into a semi-infinite loop creating directories like _build/html/_build/html/_build.... that seems to be a result of some combination of the above tools.