Skip to content

Commit

Permalink
DOC: Improve autodoc documentation
Browse files Browse the repository at this point in the history
- Write out all options using `.. rst:directive:option::`
- Cross-link the 'autodoc_default_options' to the
  descriptions of the respective directive options
- Clarify docs on how to reference directive options
  • Loading branch information
timhoffm committed Oct 1, 2024
1 parent abb3ead commit a57056a
Show file tree
Hide file tree
Showing 2 changed files with 200 additions and 132 deletions.
11 changes: 10 additions & 1 deletion doc/usage/domains/restructuredtext.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,13 @@ The reStructuredText domain (name **rst**) provides the following directives:
These roles are provided to refer to the described objects:

.. rst:role:: rst:dir
rst:role
Reference directives and directive options. Examples:

- Use ``:rst:dir:`mydirective``` to reference a directive.
- Use ``:rst:dir:`mydirective:my-option``` to reference a
directive option.

.. rst:role:: rst:role
Reference a role. Example: ``:rst:role:`myrole```.
Loading

0 comments on commit a57056a

Please sign in to comment.