docs: switch to pre-processor pattern for interface docs - #637
Open
james-garner-canonical wants to merge 1 commit into
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 switches the docs build process to build the interface docs as a pre-processor pass rather than as a Sphinx extension. The reason it wasn't a pre-processor originally is purely historical -- we started with the package dos extension, added interface docs as an extension, and then added the pre-processor approach for the library diataxis docs.
We retain a thin extension so that building the docs without the pre-processor works (it writes a placeholder file so the TOC glob doesn't fail).
The positive delta in this PR is adding tests for the pre-processor and the thin extension (the previous fat extension didn't have dedicated tests).
Context: I'm trying to speed up the docs build. This doesn't really help, but it does simplify it, so it's a good first step. I have a couple more things to try that will follow up from here.