Skip to content

doc: add example for the envvar directive - #14295

Merged
AA-Turner merged 2 commits into
sphinx-doc:masterfrom
him2him2:doc-envvar-directive-example
Oct 23, 2026
Merged

AA-Turner merged 2 commits into
sphinx-doc:masterfrom
him2him2:doc-envvar-directive-example

Conversation

@him2him2

Copy link
Copy Markdown
Contributor

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!

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 webknjaz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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?

@jdillard jdillard mentioned this pull request Jun 25, 2026
@jdillard jdillard added this to the 9.1.1 milestone Aug 13, 2026
@AA-Turner
AA-Turner merged commit 9db1715 into sphinx-doc:master Oct 23, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants