doc: add example for the envvar directive#14295
Open
him2him2 wants to merge 1 commit intosphinx-doc:masterfrom
Open
doc: add example for the envvar directive#14295him2him2 wants to merge 1 commit intosphinx-doc:masterfrom
him2him2 wants to merge 1 commit intosphinx-doc:masterfrom
Conversation
The ``.. envvar::`` directive documentation did not include an example showing that it accepts body text with a description, unlike the neighbouring ``confval`` directive which has a full example. Add one following the same pattern (RST source + rendered output).
webknjaz
approved these changes
Feb 11, 2026
Contributor
webknjaz
left a comment
webknjaz
left a comment
There was a problem hiding this comment.
The render looks good: https://sphinx--14295.org.readthedocs.build/en/14295/usage/domains/standard.html#directive-envvar. The ty failure in CI is unrelated.
cc @AA-Turner would you mind merging this?
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
2 participants
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.
Summary
The
.. envvar::directive documentation currently has no example showing that it accepts body text with a description. This contrasts with the neighbouring.. confval::directive, which has a full example (RST source + rendered output).This PR adds a matching example following the same pattern.
Hat tip to @webknjaz for the suggestion during a pytest review — thanks for pointing this out!