Skip to content

Doc: explain Napoleon configuration for import aliases #14642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jdillard wants to merge 1 commit into
base: master
Choose a base branch
from
+14 −0
Open

Doc: explain Napoleon configuration for import aliases #14642

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions doc/usage/extensions/napoleon.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -607,6 +607,20 @@ sure that "sphinx.ext.napoleon" is enabled in ``conf.py``:
:param arg2: Description of `arg2`
:type arg2: :term:`dict-like <mapping>`

Import aliases used in type definitions can be translated to names present
in intersphinx inventories. For example, to translate ``np.ndarray`` to
``numpy.ndarray``:

.. code-block:: python

napoleon_preprocess_types = True
napoleon_type_aliases = {
"np.ndarray": "numpy.ndarray",
}

Napoleon cannot infer module imports from type names written in docstrings,
so aliases must be configured explicitly.

.. versionadded:: 3.2

.. confval:: napoleon_attr_annotations
Expand Down
Loading