📝 Fix Documentation Build on ReadTheDocs And Add Documentation About Versioning #673
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
hf-krechan
changed the title
This was referenced Dec 22, 2023
Closed
hf-krechan
commented
Dec 22, 2023
Comment on lines
+7
to
+10
| try: | ||
| __version__ = version("bo4e") | ||
| except PackageNotFoundError: | ||
| __version__ = "0.0.0" |
There was a problem hiding this comment.
This is necessary because we have no version given if the commit has no semantic version in the git tag.
We got the following error message on readthedocs
File "/home/docs/.asdf/installs/python/3.11.6/lib/python3.11/importlib/metadata/__init__.py", line 565, in from_name
raise PackageNotFoundError(name)
importlib.metadata.PackageNotFoundError: No package metadata was found for bo4e
https://readthedocs.org/projects/bo4e-python/builds/22831284/ (unsure how long this link will live ...)
hf-fvesely
approved these changes
Dec 25, 2023
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 fixes the circular import issue on read the docs and adds some details how we are versioning our standard.