doc(tor, cli/info): Add documentation on Tor feature:
- Add `autodoc_pydantic` dependency for `docs`, it renders nicely Pydantic models, including the settings. - Add documentation for `li info tor` - Add a dedicated section on Tor fix 473
This commit is contained in:
parent
4fda71eeec
commit
a8ef17c5f8
1 changed files with 117 additions and 3 deletions
10
doc/conf.py
10
doc/conf.py
|
|
@ -59,7 +59,7 @@ rst_prolog = """
|
|||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = ["sphinx.ext.autodoc", "docstring"]
|
||||
extensions = ["sphinx.ext.autodoc", "docstring", "sphinxcontrib.autodoc_pydantic"]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = [".templates"]
|
||||
|
|
@ -193,3 +193,11 @@ epub_exclude_files = ["search.html"]
|
|||
|
||||
|
||||
# -- Extension configuration -------------------------------------------------
|
||||
|
||||
## autodoc_pydantic
|
||||
|
||||
autodoc_pydantic_settings_show_config_summary = False
|
||||
autodoc_pydantic_settings_show_json = False
|
||||
autodoc_pydantic_settings_show_field_summary = False
|
||||
autodoc_pydantic_settings_member_order = "bysource"
|
||||
autodoc_pydantic_field_signature_prefix = ""
|
||||
|
|
|
|||
Loading…
Reference in a new issue