-
Notifications
You must be signed in to change notification settings - Fork 125
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
The naive approach in 22.04 for repurposing the example notebooks was to copy the examples directory into the Sphinx source directory and build. This simple approach was OK for some repositories and not OK for many.
The major downside for examples directories that have subdirectories, is that we needed to use README.rst with toctree directives or the notebooks were orphaned from the navigation. Using RST is too inconvenient and we need a way to repurpose the README.md files that already exist.
After evaluating AutoStructify and sphinx-external-toc, I think the better choice is to use sphinx-external-toc.
- Change all repos to use sphinx-external-toc.
- Change all repos to use a fork of sphinx-multiversion so that recent tagged releases can use sphinx-external-toc as well.
- Add sphinxcontrib-copydirs to all repos so that examples are copied into the Sphinx source directory and that images are copied from the examples directory (and subdirectories) into the Sphinx build output.
karlhigley
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation