diff options
| author | Rob Ruana <rob@relentlessidiot.com> | 2014-03-09 01:56:56 -0500 |
|---|---|---|
| committer | Rob Ruana <rob@relentlessidiot.com> | 2014-03-09 01:56:56 -0500 |
| commit | 0deddff3813aefd50fb7d853584d0a9330bf063c (patch) | |
| tree | 3754ab9ab99a7abe59c27cabd563df3cf45752e5 /doc/ext | |
| parent | 151838e2749b57816cf29e8d2b9e8fcc665751c7 (diff) | |
| download | sphinx-0deddff3813aefd50fb7d853584d0a9330bf063c.tar.gz | |
Closes #1396: Param types with inline markup no longer italicized
Napoleon was attempting to render nested inline markup
( [a big no-no!](http://sphinx-doc.org/rest.html) ) for
parameter types. Now, if Napoleon sees any backquotes
in the parameter type, it is rendered without italics.
Diffstat (limited to 'doc/ext')
| -rw-r--r-- | doc/ext/napoleon.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/ext/napoleon.rst b/doc/ext/napoleon.rst index 32deecb8..9dda29c6 100644 --- a/doc/ext/napoleon.rst +++ b/doc/ext/napoleon.rst @@ -197,8 +197,8 @@ enabled in `conf.py`:: napoleon_use_admonition_for_notes = False napoleon_use_admonition_for_references = False napoleon_use_ivar = False - napoleon_use_param = False - napoleon_use_rtype = False + napoleon_use_param = True + napoleon_use_rtype = True .. _Google style: http://google-styleguide.googlecode.com/svn/trunk/pyguide.html @@ -328,7 +328,7 @@ enabled in `conf.py`:: True to use a ``:param:`` role for each function parameter. False to use a single ``:parameters:`` role for all the parameters. - *Defaults to False.* + *Defaults to True.* This `NumPy style`_ snippet will be converted as follows:: @@ -356,7 +356,7 @@ enabled in `conf.py`:: .. confval:: napoleon_use_rtype True to use the ``:rtype:`` role for the return type. False to output - the return type inline with the description. *Defaults to False.* + the return type inline with the description. *Defaults to True.* This `NumPy style`_ snippet will be converted as follows:: |