swh.web.doc_config module¶
-
class
swh.web.doc_config.
SimpleDocumenter
(directive: DocumenterBridge, name: str, indent: str = '')[source]¶ Bases:
sphinx.ext.autodoc.FunctionDocumenter
Custom autodoc directive to display a docstring unindented and without function signature header.
-
objtype
= 'simple'¶
-
priority
= -1¶
-
content_indent
= ''¶
-
-
swh.web.doc_config.
customize_sphinx_conf
(sphinx_conf)[source]¶ Utility function used to customize the sphinx doc build for swh-web globally (when building doc from swh-docs) or locally (when building doc from swh-web).
- Parameters
sphinx_conf (module) – a reference to the sphinx conf.py module used to build the doc.