allow documentation build using hawkmoth from source tree #204
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
Unify with the CI check in makefile.yml instead of calling sphinx-build directly here.
Preserve SPHINXOPTS for having non-empty defaults in upcoming changes, and use O make variable for things that are only set on the command-line.
For the purposes of testing and CI, it's preferrable to use the package as it is installed instead of directly from source. See commits 9ad923e ("build: actually package hawkmoth.ext.*") and f8421b1 ("move source under src/"). However, sometimes it's convenient to use the extension from the source tree for the documentation build, instead of forcing the use of a virtual environment. Add src/ in Python path when usage of installed package is not explicitly required and we're not on Read the Docs. Use the 'use-installed-hawkmoth' Sphinx tag for the former, and set it in SPHINXOPTS by default for 'make html'. The Read the Docs config also installs the package, so we can use that. Direct sphinx-build will use the extension from source, as will 'make SPHINXOPTS="" html'. Fixes: #203
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.
Address #203 while also using the installed package for CI and testing. Best of both worlds?