docs: use autosummary
continuous-integration/drone/push Build is passing Details

This commit is contained in:
Anna “CyberTailor” 2023-06-26 18:23:04 +05:00
parent 8f88a9ead6
commit dcc0e443d4
Signed by: CyberTaIlor
GPG Key ID: E7B76EDC50864BB1
2 changed files with 12 additions and 11 deletions

View File

@ -19,6 +19,7 @@ release = '0.3.0'
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'sphinx.ext.autosummary',
'sphinx.ext.autodoc',
'sphinx-prompt',
]
@ -43,7 +44,13 @@ except ModuleNotFoundError:
root_doc = 'toc'
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
manpages_url = 'https://docs.sysrq.in/{path}'
autodoc_default_flags = [
"members",
"show-inheritance",
"inherited-members",
"undoc-members",
]
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

View File

@ -5,14 +5,8 @@
API Reference
=============
gentle.generators
-----------------
.. autosummary::
:toctree: api
:recursive:
.. automodule:: gentle.generators
:members:
gentle.metadata
---------------
.. automodule:: gentle.metadata
:members:
gentle