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

Documentation tweaks

Browse Source
This commit is contained in:
Ashley Whetter 2020-01-03 09:22:57 -08:00
parent d71ac5f250
commit 4bccd1bfe7
2 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CHANGELOG.rst
View File

@ -3,9 +3,18 @@ Changelog
Versions follow `Semantic Versioning <https://semver.org/>`_ (``<major>.<minor>.<patch>``).
v1.2.1 (2019-10-9)
v1.3.0 (TBC)
------------
Features
^^^^^^^^
* `#151 <https://github.com/rtfd/sphinx-autoapi/issues/151>`: (Python) Added the ``autoapi_python_use_implicit_namespaces`` option to allow
AutoAPI to search for implicit namespace packages.
v1.2.1 (2019-10-9)
------------------
Bug Fixes
^^^^^^^^^
@ -14,7 +23,7 @@ Bug Fixes
v1.2.0 (2019-10-5)
------------
------------------
Features
^^^^^^^^

13
docs/reference/config.rst
View File

@ -139,8 +139,17 @@ Customisation Options
Default: ``False``
Wether to consider all directories as root of namespace.
This changes the package detection behaviour to be compatible with PEP420.
This changes the package detection behaviour to be compatible with :pep:`420`,
but directories in :confval:`autoapi_dirs`
are no longer searched recursively for packages.
Instead, when this is ``True``,
:confval:`autoapi_dirs` should point directly to
the directories of implicit namespaces
and the directories of packages.
If searching is still required,
this should be done manually in the ``conf.py``.
Events
~~~~~~