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
Show Stats 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

8
doc/usage/extensions/intersphinx.rst
View File

@ -220,10 +220,12 @@ Showing all links of an Intersphinx mapping file
------------------------------------------------
To show all Intersphinx links and their targets of an Intersphinx mapping file,
run ``python -msphinx.ext.intersphinx url-or-path``. This is helpful when
run ``python -m sphinx.ext.intersphinx url-or-path``. This is helpful when
searching for the root cause of a broken Intersphinx link in a documentation
project. The following example prints the Intersphinx mapping of the Python 3
documentation::
project.
The following example prints the Intersphinx mapping of the Python documentation:
.. code-block:: console
$ python -m sphinx.ext.intersphinx https://docs.python.org/3/objects.inv

2
doc/usage/extensions/napoleon.rst
View File

@ -212,7 +212,7 @@ type checkers and IDEs can take advantage of them for static code
analysis. :pep:`484` was then extended by :pep:`526` which introduced
a similar way to annotate variables (and attributes).
Google style with Python 3 type annotations:
Google style with type annotations:
.. code-block:: python