usb-tools/amaranth
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs: introduce custom "Members" section, for lib.wiring signatures.

Browse source
This commit is contained in:
Catherine 2024-03-22 07:24:10 +00:00
parent 6b512520ff
commit e3c9296813
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/conf.py
View file

@ -39,7 +39,11 @@ napoleon_numpy_docstring = True
napoleon_use_ivar = True
napoleon_include_init_with_doc = True
napoleon_include_special_with_doc = True
napoleon_custom_sections = ["Platform overrides"]
napoleon_custom_sections = [
("Attributes", "params_style"), # by default displays as "Variables", which is confusing
("Members", "params_style"), # `lib.wiring` signature members
"Platform overrides"
]
html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]