Skip to content

doc: use builtin confval directive, add :type: and :default: #14012

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

Open
bluetech wants to merge 2 commits into
base: main
Choose a base branch
from
+124 −83
Open

doc: use builtin confval directive, add :type: and :default: #14012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41179d5
doc: use builtin `confval` directive
bluetech Nov 28, 2025
b47e4e1
doc: make use of `confval`'s `type' and `default` options
bluetech Nov 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog/14012.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The :ref:`ini options ref` section of the API Reference now specified the type and default value of every configuration option.
1 change: 1 addition & 0 deletions changelog/14012.packaging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Sphinx>=7.4 is now required to build the documentation.
7 changes: 0 additions & 7 deletions doc/en/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,13 +279,6 @@ def setup(app: sphinx.application.Sphinx) -> None:
indextemplate="pair: %s; fixture",
)

app.add_object_type(
"confval",
"confval",
objname="configuration value",
indextemplate="pair: %s; configuration value",
)

app.add_object_type(
"globalvar",
"globalvar",
Expand Down
Loading