Skip to content

doc: indent envvar directive bodies in reference.rst#14183

Merged
nicoddemus merged 1 commit intopytest-dev:mainfrom
him2him2:doc-envvar-indent
Feb 12, 2026
Merged

doc: indent envvar directive bodies in reference.rst#14183
nicoddemus merged 1 commit intopytest-dev:mainfrom
him2him2:doc-envvar-indent

Conversation

@him2him2
Copy link
Contributor

Split from #14181 per @webknjaz's review — keeping changes atomic.

Changes

Indent the body text of all 14 .. envvar:: entries with 3 spaces, matching the .. confval:: convention used in the same file. This was the only section with unindented directive bodies.

Rendered preview (from the combined PR): https://pytest--14181.org.readthedocs.build/en/14181/reference/reference.html#environment-variables

@webknjaz webknjaz added type: docs documentation improvement, missing or needing clarification skip news used on prs to opt out of the changelog requirement backport 9.0.x apply to PRs at any point; backports the changes to the 9.0.x branch labels Feb 11, 2026
@webknjaz webknjaz enabled auto-merge February 11, 2026 18:29
Copy link
Member

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

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

@him2him2 could you rebase this PR with conflict resolution? Looks like merging #14179 blocks GitHub from merging this one automatically.

Indent the body text of all 14 ``.. envvar::`` entries with 3 spaces,
matching the ``.. confval::`` convention used in the same file.
This was the only section with unindented directive bodies.
auto-merge was automatically disabled February 12, 2026 15:24

Head branch was pushed to by a user without write access

Copy link
Member

@nicoddemus nicoddemus left a comment

Choose a reason for hiding this comment

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

Indeed, according to the Sphinx examples, the text should be indented to match the envvar directive. 👍

@nicoddemus nicoddemus merged commit 3740cb9 into pytest-dev:main Feb 12, 2026
33 checks passed
@patchback
Copy link

patchback bot commented Feb 12, 2026

Backport to 9.0.x: 💚 backport PR created

✅ Backport PR branch: patchback/backports/9.0.x/3740cb962027ed73460c04568b409ef8c52af99e/pr-14183

Backported as #14187

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@nicoddemus
Copy link
Member

Thanks @him2him2!

patchback bot pushed a commit that referenced this pull request Feb 12, 2026
Indent the body text of all 14 ``.. envvar::`` entries with 3 spaces, matching the ``.. confval::`` convention used in the same file.

This was the only section with unindented directive bodies.

(cherry picked from commit 3740cb9)
nicoddemus pushed a commit that referenced this pull request Feb 12, 2026
Indent the body text of all 14 ``.. envvar::`` entries with 3 spaces, matching the ``.. confval::`` convention used in the same file.

This was the only section with unindented directive bodies.

(cherry picked from commit 3740cb9)

Co-authored-by: Ronald Eddy Jr <ronald_eddy@yahoo.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 9.0.x apply to PRs at any point; backports the changes to the 9.0.x branch skip news used on prs to opt out of the changelog requirement type: docs documentation improvement, missing or needing clarification

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants