Update document versioning for PR #724 #735
Open
+401
−5
Conversation
This file contains hidden or 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
seagater
requested review from
Binyang2014,
caiomcbr,
chhwang,
Copilot and
mahdiehghazim
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the documentation build system to support versioning, building on PR #724. It configures sphinx-multiversion to generate documentation for different versions and adds a version selector to the documentation website.
Changes:
- Adds sphinx-multiversion dependency and configuration to build versioned documentation from git tags
- Creates automated version generation script that syncs documentation versions with git tags
- Updates build system to support both single-version (development) and multi-version (production) builds
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/requirements.txt | Adds sphinx-multiversion==0.2.4 dependency for multi-version documentation support |
| docs/generate_versions.py | New Python script to auto-generate versions.js from git tags, filtering versions before v0.4.0 |
| docs/conf.py | Configures sphinx-multiversion extension and adds build hooks to copy version selector files |
| docs/_templates/layout.html | New Jinja2 template adding version selector UI component to documentation sidebar |
| docs/_static/version-selector.js | JavaScript implementing version selector with page existence checking using HEAD requests |
| docs/Makefile | Adds multiversion build target and integrates version generation into build process |
| .gitignore | Ignores auto-generated versions.js file |
| .github/workflows/gh-pages.yml | Updates CI/CD to use multiversion build target for production deployments |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ub.com/microsoft/mscclpp into qinghuazhou/document_versioning_revise
… the duplicated version selector from layout.html
Binyang2014
approved these changes
Jan 29, 2026
Contributor
Binyang2014
left a comment
Binyang2014
left a comment
There was a problem hiding this comment.
Pls also update the file: .github/workflows/doc-build.yaml
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 fix the issue of generating docs when we take #724 into main branch.
Build docs for main branch separately.
Use HEAD request instead of GET to check if a page exist.
Filter out versions before v0.4.0 in generate_versions.py.