Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/4492.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added comprehensive CLI options reference documentation in the reference section, documenting all command-line flags with detailed descriptions and examples. Added a new ``:optionval:`` role for cross-referencing CLI options throughout the documentation.
7 changes: 7 additions & 0 deletions doc/en/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,13 @@ def setup(app: sphinx.application.Sphinx) -> None:
indextemplate="pair: %s; global variable interpreted by pytest",
)

app.add_object_type(
"optionval",
"optionval",
objname="command-line option",
indextemplate="pair: %s; command-line option",
)

app.add_crossref_type(
directivename="hook",
rolename="hook",
Expand Down
Loading