Catch importlib error when building docs with sphinx-build manually #182
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
jl-wynen
reviewed
May 27, 2024
| release = get_version("{{projectname}}") | ||
| version = ".".join(release.split('.')[:3]) # CalVer | ||
| except PackageNotFoundError: | ||
| release = version = "0.0.0-dev" |
There was a problem hiding this comment.
Can you add a print or log to make it easier to trace if something breaks in CI? Otherwise 👍
jl-wynen
approved these changes
May 27, 2024
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.
In some cases, where a local source for a package (e.g. in the PYTHONPATH) is used instead of a
pipinstall package, theget_version()in thedocs/conf.pyfails withimportlib.metadata.PackageNotFoundError: No package metadata was found for PACKAGEwhen usingsphinx-builddirectly (instead of going viatox -e docs).These changes allows one to use
sphinx-builddirectly, which is sometimes needed for debugging purposes.