Skip to content
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

[Docs] Fix --branch magic to not collide variable with sphinx tags #2073

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Docs] Fix --branch magic to not collide variable with sphinx tags #2073

wants to merge 1 commit into from

Commits on Nov 29, 2024

  1. [Docs] Fix --branch magic to not collide variable with sphinx tags 

    A mistake was made in commit c9dca72
("[Docs] quickstart: Add specific checkout to stable versions") that the
variable name (`tags`) was chosen to collide with Sphinx' special
configuration variable:
https://www.sphinx-doc.org/en/master/usage/configuration.html#project-tags
This went unnoticed, because at the time we were not using project tags.
Later, in commit 6ebc605 ("[Docs]
Update sphinx to 5.3"), we started using this feature. The mistake was
still unnoticed, because the stable checkout was under condition that is
true only rarely.

Fixes: c9dca72 ("[Docs] quickstart: Add specific checkout to stable versions")
Fixes: 6ebc605 ("[Docs] Update sphinx to 5.3")
Signed-off-by: Wojtek Porczyk <[email protected]>
    @woju
    woju committed Nov 29, 2024
    Configuration menu
    Copy the full SHA
    c9e2d3f View commit details
    Browse the repository at this point in the history