Skip to content

Hotfix versioning readthedocs #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JaLuka98 merged 4 commits into from
Jun 8, 2025
Merged

Hotfix versioning readthedocs #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e98369
Take version from importing cpax instead of getting it from installed…
JaLuka98 May 22, 2025
f4dcecf
Move up import to adhere to style guidelines
JaLuka98 Jun 8, 2025
cd59a9a
Wrap version import in try except
JaLuka98 Jun 8, 2025
11cf375
Install package during readthedocs building to allow version to be fe…
JaLuka98 Jun 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ sphinx:

# declare the Python requirements required to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# Install the package itself so that the version can be fetched dynamically during docs building (see docs/source/conf.py)
python:
install:
- requirements: docs/requirements.txt
install:
- method: pip
path: .
extra_requirements: [docs]
10 changes: 8 additions & 2 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,19 @@

import os
import sys
try:
from cpax import __version__
except (ImportError, AttributeError) as e:
raise RuntimeError(
"Failed to import `__version__` from the `cpax` package. Ensure that the `cpax` package is installed "
"and contains a `__version__` attribute."
) from e
sys.path.insert(0, os.path.abspath('../../src'))
import importlib.metadata

project = 'CPax'
copyright = '2025, Jan Lukas Späh'
author = 'Jan Lukas Späh'
release = importlib.metadata.version("cpax")
release = __version__
version = ".".join(release.split(".")[:2])

# -- General configuration ---------------------------------------------------
Expand Down