Archives/sphinx-autoapi
2
0
Fork 0
mirror of https://github.com/readthedocs/sphinx-autoapi synced 2024-11-17 21:25:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Add autoapi_python_use_implicit_namespaces config value description

Browse Source 
+
This commit is contained in:
Olivier Samyn 2019-10-15 10:47:47 +02:00 committed by Ashley Whetter
parent 5f085ca47f
commit a836795d17
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reference/config.rst
View File

@ -135,6 +135,13 @@ Customisation Options
docstring is empty and the class defines a ``__new__`` with a docstring, docstring is empty and the class defines a ``__new__`` with a docstring,
the ``__new__`` docstring is used instead of the ``__init__`` docstring. the ``__new__`` docstring is used instead of the ``__init__`` docstring.
.. confval:: autoapi_python_use_implicit_namespaces
Default: ``False``
Wether to consider all directories as root of namespace.
This changes the package detection behaviour to be compatible with PEP420.
Events Events
~~~~~~ ~~~~~~