Documentation reorg #6
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This includes just the Python "kinetics" examples to start
Sphinx-gallery creates new .rst files alongside existing manually maintained documentation, and runs the samples in-place, generating their output files in the source tree. Moving this all to the build directory lets us keep the repo clean.
This was causing problems with re-importing cantera.with_units.units while running the samples as part of the sphinx-gallery build
This sidebar usually only had a "get page source" link, which isn't very useful for autogenerated pages.
Introduce a monkey patch to avoid executing specific examples that won't run under sphinx-gallery.
Put C++ API documentation on an equal footing
speth
force-pushed
the
doc-linking-trial
branch
from
910a9ba
to
dcb2d5b
Compare
Use LatticePhase as an initial trial for moving scientific model docs into Sphinx using MyST.
Copy Doxygen output into a subdirectory of Sphinx so the Sphinx index can be the full site index. Partially addresses Cantera/cantera-website#229
Adds dependency on myst-nb, which is currently pinned to Sphinx<6
speth
force-pushed
the
doc-linking-trial
branch
from
dcb2d5b
to
91d33ff
Compare
speth
force-pushed
the
examples-website
branch
from
62d35be
to
d317d27
Compare
|
Resolved in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a temporary PR for showing the changes to the documentation organization, from the starting point of Cantera#1621.