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.

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

Fix |release| RST substitution in docs having incomplete values for development versions #12538

Open
RonnyPfannschmidt opened this issue Jun 26, 2024 · 1 comment
Assignees
Labels
type: docs documentation improvement, missing or needing clarification

Comments

@RonnyPfannschmidt
Copy link
Member

@RonnyPfannschmidt this results in the |release| RST substitution having the value of 8.2 which might have a weird perception in changelog draft titles: https://docs.pytest.org/en/8.2.x/changelog.html#to-be-included-in-vrelease-if-present / https://docs.pytest.org/en/latest/changelog.html#to-be-included-in-vrelease-if-present.

Should this be something like +dev in the end but without a variable component, something static? Though, perhaps in RTD it'd be okay to use the long original version.

Ursprünglich gepostet von @webknjaz in #12467 (comment)

@webknjaz
Copy link
Member

I filed an upstream issue on letting these not influence the caching mechanism: sphinx-doc/sphinx#12480.

@Zac-HD Zac-HD changed the title @RonnyPfannschmidt this results in the |release| RST substitution having the value of 8.2 which might have a weird perception in changelog draft titles: https://docs.pytest.org/en/8.2.x/changelog.html#to-be-included-in-vrelease-if-present / https://docs.pytest.org/en/latest/changelog.html#to-be-included-in-vrelease-if-present. Fix |release| RST substitution in docs having incomplete values for development versions Jul 6, 2024
@Zac-HD Zac-HD added the type: docs documentation improvement, missing or needing clarification label Jul 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs documentation improvement, missing or needing clarification
Projects
None yet
Development

No branches or pull requests

3 participants