Draft
Update Makefile doc target to run doctest then html builders#193
Conversation
Co-authored-by: eh-main-bot <171766998+eh-main-bot@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update Makefile 'doc' target to run doctest before html
Update Makefile doc target to run doctest then html builders
Jun 10, 2025
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
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.
Updates the
doctarget in the Makefile to run both the doctest and html sphinx builders sequentially, as requested in the issue.Changes Made
The
doctarget now executes two sphinx-build commands:doc: uv run --no-sync sphinx-build -M doctest docs/source docs/build/ -W --keep-going --fresh-env uv run --no-sync sphinx-build -M html docs/source docs/build/ -W --keep-going --fresh-envBoth commands use the same arguments (
-W --keep-going --fresh-env) to ensure consistent behavior and error handling.Benefits
make doccommandTesting
make doctestwhich depends on thedoctargetThis is a minimal, surgical change that adds doctest validation to the documentation build process without affecting any other functionality.