diff --git a/doc/ext/example_google.py b/doc/ext/example_google.py index bc0fd5569..81a312cfd 100644 --- a/doc/ext/example_google.py +++ b/doc/ext/example_google.py @@ -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 diff --git a/doc/ext/example_numpy.py b/doc/ext/example_numpy.py index 68bc9d289..bb91cac82 100644 --- a/doc/ext/example_numpy.py +++ b/doc/ext/example_numpy.py @@ -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 diff --git a/sphinx/ext/napoleon/__init__.py b/sphinx/ext/napoleon/__init__.py index 5710dd50d..6124ee9be 100644 --- a/sphinx/ext/napoleon/__init__.py +++ b/sphinx/ext/napoleon/__init__.py @@ -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 + `_ - .. _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 `_ + + `The Extension API `_ """ from sphinx.application import Sphinx