Skip to content

Version needs to be set to actual version and not just keyword _latest_#2437

Merged
shaahji merged 1 commit intomainfrom
shaahji/docs
Apr 25, 2026
Merged

Version needs to be set to actual version and not just keyword _latest_#2437
shaahji merged 1 commit intomainfrom
shaahji/docs

Conversation

@shaahji
Copy link
Copy Markdown
Collaborator

@shaahji shaahji commented Apr 24, 2026

Version needs to be set to actual version and not just keyword latest

Checklist before requesting a review

  • Add unit tests for this change.
  • Make sure all tests can pass.
  • Update documents if necessary.
  • Lint and apply fixes to your code by running lintrunner -a
  • Is this a user-facing change? If yes, give a description of this change to be included in the release notes.

(Optional) Issue link

Copilot AI review requested due to automatic review settings April 24, 2026 23:17
@shaahji shaahji enabled auto-merge (squash) April 24, 2026 23:18
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Sphinx documentation configuration so the displayed docs version is a concrete value rather than the placeholder "latest", aligning with the docs versioning approach used by the version switcher.

Changes:

  • Set version in docs/source/conf.py from "latest" to "0.12.1".

Comment thread docs/source/conf.py
Comment on lines +22 to 23
version = "0.12.1"
release = version
Copy link

Copilot AI Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

version is used as the pydata-sphinx-theme version switcher version_match (see html_theme_options['switcher']['version_match']). On main, this should match the versions.json entry for the root docs (currently "main"), not a pinned release like 0.12.1, otherwise the switcher will not select the current docs version and the site will be mislabeled.

Suggested change
version = "0.12.1"
release = version
release = "0.12.1"
_docs_version = os.environ.get("READTHEDOCS_VERSION") or os.environ.get("GITHUB_REF_NAME")
version = "main" if _docs_version == "latest" else (_docs_version or release)

Copilot uses AI. Check for mistakes.
@shaahji shaahji merged commit a5fa485 into main Apr 25, 2026
12 checks passed
@shaahji shaahji deleted the shaahji/docs branch April 25, 2026 00:57
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