Generate Sphinx docs in markdown
This commit is contained in:
parent
bc4e9caacb
commit
81ff7959f7
84 changed files with 2873 additions and 29 deletions
|
|
@ -23,6 +23,8 @@ napoleon_google_docstring = False
|
|||
napoleon_numpy_docstring = False
|
||||
napoleon_use_param = True
|
||||
napoleon_use_rtype = True
|
||||
napoleon_google_docstring = True
|
||||
napoleon_numpy_docstring = False
|
||||
|
||||
html_theme = 'furo'
|
||||
|
||||
|
|
@ -45,6 +47,16 @@ autodoc_mock_imports = [
|
|||
'pywifi', 'sdbus', 'sdbus_async', 'sdbus_async.networkmanager',
|
||||
'dbus', 'dbus.mainloop', 'dbus.mainloop.glib',
|
||||
'pydbus', 'mac_vendor_lookup',
|
||||
# mock problematic local modules when docs are built
|
||||
'config.init_config',
|
||||
]
|
||||
|
||||
# Also prevent autosummary from importing mocked modules
|
||||
autosummary_mock_imports = autodoc_mock_imports
|
||||
|
||||
# Suppress noisy warnings for mocked objects
|
||||
suppress_warnings = [
|
||||
'autodoc.mocked_object',
|
||||
]
|
||||
|
||||
# Environment flag so code can short-circuit heavy side effects during import
|
||||
|
|
@ -55,4 +67,5 @@ autodoc_default_options = {
|
|||
'undoc-members': True,
|
||||
'private-members': False,
|
||||
'show-inheritance': True,
|
||||
'no-index': True,
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue