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

Updates #2053 [Napoleon] Updates documentation to indicate napoleon_include_special_with_doc = True by default

Browse Source
This commit is contained in:
Rob Ruana 2015-11-17 20:13:55 -08:00
parent 4061e3244d
commit e926ebb263
3 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/ext/example_google.py
View File

@ -241,16 +241,17 @@ class ExampleClass(object):
return True
def __special__(self):
"""By default special members with docstrings are included.
"""By default special members with docstrings are not included.
Special members are any methods or attributes that start with and
end with a double underscore. Any special member with a docstring
will be included in the output.
will be included in the output, if
``napoleon_include_special_with_doc`` is set to True.
This behavior can be disabled by changing the following setting in
This behavior can be enabled by changing the following setting in
Sphinx's conf.py::
napoleon_include_special_with_doc = False
napoleon_include_special_with_doc = True
"""
pass

9
doc/ext/example_numpy.py
View File

@ -286,16 +286,17 @@ class ExampleClass(object):
return True
def __special__(self):
"""By default special members with docstrings are included.
"""By default special members with docstrings are not included.
Special members are any methods or attributes that start with and
end with a double underscore. Any special member with a docstring
will be included in the output.
will be included in the output, if
``napoleon_include_special_with_doc`` is set to True.
This behavior can be disabled by changing the following setting in
This behavior can be enabled by changing the following setting in
Sphinx's conf.py::
napoleon_include_special_with_doc = False
napoleon_include_special_with_doc = True
"""
pass

12
sphinx/ext/napoleon/__init__.py
View File

@ -43,7 +43,7 @@ class Config(object):
napoleon_use_rtype = True
.. _Google style:
http://google-styleguide.googlecode.com/svn/trunk/pyguide.html
http://google.github.io/styleguide/pyguide.html
.. _NumPy style:
https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
@ -239,12 +239,12 @@ def setup(app):
See Also
--------
The Sphinx documentation on `Extensions`_, the `Extension Tutorial`_, and
the `Extension API`_.
`The Sphinx documentation on Extensions
<http://sphinx-doc.org/extensions.html>`_
.. _Extensions: http://sphinx-doc.org/extensions.html
.. _Extension Tutorial: http://sphinx-doc.org/ext/tutorial.html
.. _Extension API: http://sphinx-doc.org/ext/appapi.html
`The Extension Tutorial <http://sphinx-doc.org/extdev/tutorial.html>`_
`The Extension API <http://sphinx-doc.org/extdev/appapi.html>`_
"""
from sphinx.application import Sphinx