Skip to content

fix(docs): 🩹📄Fix doc creation for /latest #1015

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
lord-haffi merged 2 commits into from
Sep 27, 2025
Merged

fix(docs): 🩹📄Fix doc creation for /latest #1015

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46a850d
fix(docs): 🩹📄Fix doc creation for `/latest`
lord-haffi Jul 30, 2025
39467bf
Merge branch 'main' into fix_latest_docs
lord-haffi Sep 27, 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
12 changes: 7 additions & 5 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@
from bo4e_cli.models.version import Version
from bo4e_cli.utils.github_cli import get_access_token_from_cli_if_installed

from bo4e import __gh_version__, __version__

sys.path.insert(0, os.path.join(__location__, "../src"))
sys.path.insert(0, os.path.join(__location__, "../docs"))
sys.path.insert(0, os.path.join(__location__, "../docs/compatibility"))
Expand Down Expand Up @@ -204,11 +206,11 @@ def setup(app):
if "release" not in globals():
release = os.getenv("SPHINX_DOCS_RELEASE")
if not release:
from bo4e import __gh_version__ as release
release = __gh_version__
if "version" not in globals():
version = os.getenv("SPHINX_DOCS_VERSION")
if not version:
from bo4e import __version__ as version
version = __version__

print(f"Got version = {version} from __version__")
print(f"Got release = {release} from __gh_version__")
Expand Down Expand Up @@ -340,9 +342,9 @@ def setup(app):

# Create UML diagrams in plantuml format. Compile these into svg files into the _static folder.
# See docs/uml.py for more details.
release_version = Version.from_str(release)
release_version = Version.from_str(__gh_version__)
if not release_version.is_dirty():
uml.LINK_URI_BASE = f"https://bo4e.github.io/BO4E-python/{release}"
uml.LINK_URI_BASE = f"https://bo4e.github.io/BO4E-python/{__gh_version__}"
_exec_plantuml = Path(__location__) / "plantuml.jar"
_network, _namespaces_to_parse = uml.build_network(Path(module_dir), uml.PlantUMLNetwork)
print(_network)
Expand All @@ -360,7 +362,7 @@ def setup(app):
compiling_from_release_workflow = not release_version.is_dirty()
last_versions = get_last_n_tags(
n=3,
ref=str(release) if compiling_from_release_workflow else "HEAD",
ref=str(release_version) if compiling_from_release_workflow else "HEAD",
exclude_candidates=True,
exclude_technical_bumps=True,
token=gh_token,
Expand Down
Loading