IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Reference 'Python' instead of 'Python 3'

Browse Source
This commit is contained in:
Adam Turner
2025-01-26 04:52:46 +00:00
parent 9a8eeac865
commit 4d4123bbce
3 changed files with 12 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/man/sphinx-apidoc.rst
View File

@@ -103,12 +103,13 @@ 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).
Without this option, :program:`sphinx-apidoc` searches :data:`sys.path`
for Python packages containing :file:`__init__.py` files,
or single-file Python modules.
Interpret paths recursively according to PEP-0420.
This option instead uses :pep:`420` implicit namespaces that allow
layouts paths such as ``foo/bar/module.py`` or ``foo/bar/baz/__init__.py``
(note that ``bar`` and ``foo`` are namespaces, not modules).
.. option:: -M, --module-first