diff options
| author | Arcadiy Ivanov <arcadiy@ivanov.biz> | 2016-09-12 18:17:03 -0400 |
|---|---|---|
| committer | Arcadiy Ivanov <arcadiy@ivanov.biz> | 2016-09-15 11:49:34 -0400 |
| commit | e34b6823c7b51d5d0f424e00bca012076d802a14 (patch) | |
| tree | 24b8f9cdfae2a72e1109eb30e15565756895c1e6 /doc/invocation.rst | |
| parent | c832d36d19ba13e0009f28f54749a9be690f6500 (diff) | |
| download | sphinx-git-e34b6823c7b51d5d0f424e00bca012076d802a14.tar.gz | |
Sphinx apidoc does not process PEP-0420 implicit namespaces
fixes #2949, connected to #2949
Diffstat (limited to 'doc/invocation.rst')
| -rw-r--r-- | doc/invocation.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/invocation.rst b/doc/invocation.rst index 6e9a25606..59bb5108c 100644 --- a/doc/invocation.rst +++ b/doc/invocation.rst @@ -453,6 +453,15 @@ The :program:`sphinx-apidoc` script has several options: to default values, but you can influence the most important ones using the following options. +.. option:: --implicit-namespaces + + By default `sphinx-apidoc` processes sys.path searching for modules only. + Python 3.3 introduced :pep:`420` implicit namespaces that allow module path + structures such as `foo/bar/module.py` or `foo/bar/baz/__init__.py` + (notice that `bar` and `foo` are namespaces, not modules). + + Specifying this option interprets paths recursively according to PEP-0420. + .. option:: -M This option makes sphinx-apidoc put module documentation before submodule |