DM-36883: Configure sphinx build with technote.toml #4
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
These sphinx configurations expressed in Pydantic/TOML were originally developed for our Rubin user guide theme in Documenteer. I'm re-adapting theme here for Technote. In technote the Sphinx configurations are simpler because the format is more constrained. The base Sphinx configuration module will load the [technote.sphinx] table data and apply these configurations to the Sphinx config.
Technically we're already intending for a single page build, but now this ensures that happens. It also prevents sphinx from generating unneeded indices and extra pages.
This establishes the basic system for configuring the sphinx build using technote.toml. The technote.sphinxconf module provides the base Sphinx configuration for conf.py. The TechnoteSphinxConfig class contains an instance of the TechnoteTable model representing the technote.toml file, and also provides helper methods for setting variables in the conf.py/technote.sphinxconf context.
52351a6 to
2dea9fa
Compare
The TechnoteJinjaContext provides a class along with the technote.toml dataset that's accessible from the Jinja context for HTML templates as the "technote" global variable.
Note we might need to ensure the canonical URL link rel is being emitted by the template.
d1ece72 to
3f1bd7d
Compare
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 PR implements a base sphinx configuration module,
technote.sphinx, and aTechnoteSphinxConfigclass that provides helper methods for configuring Sphinx configuration variables using data from thetechnote.toml-based models.