Sphinx Versioning#61
Merged
Merged
Conversation
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Introduce Sphinx Versioning (#57) * Sphinx Versioning * Linking latest dir rather than copying * Function signaturevariable name fixed * source validaton for latest * Try catch for git tags absence Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Lint and format issue solve * lint fix * Indentation fix Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Lint fix * fetch tags in ci * Readme fix * Remove force --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…#60) * Introduce Sphinx Versioning (#57) * Sphinx Versioning * Linking latest dir rather than copying * Function signaturevariable name fixed * source validaton for latest * Try catch for git tags absence Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Lint and format issue solve * lint fix * Indentation fix Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Lint fix * fetch tags in ci * Readme fix * Remove force * Local build single version * Redirect the root to latest * Documentation update * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds Sphinx versioning capabilities to the documentation build system, enabling multi-version documentation with automatic version detection from git tags and a convenient redirect to the latest version.
Changes:
- Added a
--localflag to build single-version documentation for local development - Implemented root-level redirect from
/to/latest/documentation - Updated documentation and workflow configuration to support multi-version builds
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| run.py | Added --local flag, create_root_redirect() function, and updated build_docs() to support local single-version builds |
| docs/source/readme.rst | Added documentation for new --local flag, local viewing instructions, and versioned documentation features |
| README.md | Updated with --local flag documentation, viewing instructions, and versioned documentation overview |
| .github/workflows/publish.yml | Added fetch-depth: 0 and git fetch --tags to ensure all version tags are available for multi-version builds |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
osinjoku
approved these changes
Jan 19, 2026
omkar-p-adsk
approved these changes
Jan 19, 2026
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
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.
Description
Add sphinx versioning to the main branch
Type of change
Checklist