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

Documentation reorg #6

Closed
wants to merge 31 commits into from
Closed

Documentation reorg #6

wants to merge 31 commits into from

Conversation

speth
Copy link
Owner

@speth speth commented Sep 30, 2023

This is a temporary PR for showing the changes to the documentation organization, from the starting point of Cantera#1621.

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
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
@speth
Copy link
Owner Author

speth commented Oct 17, 2023

Resolved in Cantera/cantera repository.

@speth speth closed this Oct 17, 2023
@speth speth deleted the doc-linking-trial branch October 17, 2023 15:28
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

Successfully merging this pull request may close these issues.

1 participant