Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes to how we build the docs #210

Open
rjleveque opened this issue Apr 14, 2020 · 3 comments
Open

Changes to how we build the docs #210

rjleveque opened this issue Apr 14, 2020 · 3 comments

Comments

@rjleveque
Copy link
Member

I'd like to propose the following:

  1. Switch from using sphinxcontrib-versioning to sphinx-multiversion as discussed in sphinx-multiversion to replace sphinxcontrib-versioning? #209.

  2. Stop using nbsphinx to 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 a doc/pyclaw/tutorials/burgers/pyclaw_tutorial.ipynb file that no longer exists, but when trying to build v5.3.1, for example, it tries to run nbconvert on this notebook, which fails since this doesn't run with the current clawpack.

    Using nbsphinx also 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/notebooks and use the script gallery/notebooks/make_html_from_notebooks.py to convert them to html version in the gallery of notebooks.

  3. Stop using intersphinx to 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.

@ketch
Copy link
Member

ketch commented Apr 15, 2020

All of these changes seem good to me.

@mandli
Copy link
Member

mandli commented Apr 15, 2020

+1

@rjleveque
Copy link
Member Author

OK, I will implement all this for v5.7.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants