You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
sphinx.ext.napoleon should generate markup similar to the default one. In particular, the current output uses the :exc: interpreted text role, which is only defined by sphinx's python domain, and thus not interpretable by docutils without using sphinx. This is specifically more relevant for projects which would like to parse google/numpy docstrings e.g. with sphinxcontrib.napoleon then feed the results into docutils themselves, without needing sphinx itself (e.g., http://defopt.readthedocs.io/en/latest/).
Reproducible project / your project
N/A
Environment info
OS: Arch Linux
Python version: 3.6
Sphinx version: 1.5.5
The text was updated successfully, but these errors were encountered:
Subject: docstrings parsed by sphinx.ext.napoleon use a subtly different markup for documented exceptions.
Problem
(see subject)
Procedure to reproduce the problem
http://www.sphinx-doc.org/en/stable/domains.html?highlight=domains#info-field-lists indicates that exceptions should be documented as
but sphinx.ext.napoleon (whether Google or Numpy style) uses a different markup:
Expected results
sphinx.ext.napoleon should generate markup similar to the default one. In particular, the current output uses the
:exc:
interpreted text role, which is only defined by sphinx's python domain, and thus not interpretable by docutils without using sphinx. This is specifically more relevant for projects which would like to parse google/numpy docstrings e.g. with sphinxcontrib.napoleon then feed the results into docutils themselves, without needing sphinx itself (e.g., http://defopt.readthedocs.io/en/latest/).Reproducible project / your project
N/A
Environment info
The text was updated successfully, but these errors were encountered: