Skip to content

Fix missing directory of document for new tag v0.9.0 #776

Merged
mahdiehghazim merged 2 commits intomainfrom
qinghuazhou/fix_version_dection_for_new_tag
Apr 8, 2026
Merged

Fix missing directory of document for new tag v0.9.0 #776
mahdiehghazim merged 2 commits intomainfrom
qinghuazhou/fix_version_dection_for_new_tag

Conversation

@seagater
Copy link
Copy Markdown
Contributor

@seagater seagater commented Apr 8, 2026

The v0.9.0 conf.py (introduced in #775) dynamically loads the version from python/mscclpp/_version.py.

This file is generated at build time by setuptools_scm and is listed in .gitignore — it is never committed to the repo. Earlier tags (v0.8.0 and below) used a hardcoded release (e.g., "v0.8.0") in conf.py, so they had no dependency on generated files.
sphinx-multiversion checks out each tag using git archive, which only extracts committed files.
Since _version.py is not committed, the v0.9.0 checkout is missing it, and conf.py crashes on import. All future tags will have this same problem.

Three changes:

  1. docs/build_multiversion.py (new): A wrapper around sphinx-multiversion that monkey-patches copy_tree to generate _version.py in each tag checkout after extraction. The version string is parsed from the tag name (e.g., v0.9.0 → version = "0.9.0").
  2. Makefile: The multiversion target now calls build_multiversion.py instead of sphinx-multiversion directly.
  3. conf.py: Added a fallback so that if _version.py doesn't exist, it reads the version from the VERSION file instead. This makes conf.py resilient for any future scenario where _version.py is missing.

Testing
Verified locally:
• make multiversion now successfully builds all 11 versions (v0.4.0 through v0.9.0)
• v0.9.0 docs are correctly generated under _build/html/v0.9.0/
Version selector shows v0.9.0 as latest

@seagater seagater requested a review from a team April 8, 2026 20:31
@mahdiehghazim mahdiehghazim merged commit ed565ce into main Apr 8, 2026
7 checks passed
@mahdiehghazim mahdiehghazim deleted the qinghuazhou/fix_version_dection_for_new_tag branch April 8, 2026 21:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants