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 Napoleon documentation per suggestion by a user

Browse Source
This commit is contained in:
Rob Ruana
2014-04-26 19:43:46 -04:00
parent bbfd0d058a
commit 7f710be021
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/ext/napoleon.rst
View File

@@ -38,9 +38,14 @@ according to the `Google Python Style Guide`_::
Much more legible, no?
Napoleon is a Sphinx extension that allows you to write readable API
documentation in your source code. Napoleon understands both `NumPy`_ and
`Google`_ style docstrings - the style recommended by `Khan Academy`_.
Napoleon is a `Sphinx extension`_ that enables Sphinx to parse both `NumPy`_
and `Google`_ style docstrings - the style recommended by `Khan Academy`_.
Napoleon is a pre-processor that parses `NumPy`_ and `Google`_ style
docstrings and converts them to reStructuredText before Sphinx attempts to
parse them. This happens in an intermediate step while Sphinx is processing
the documentation, so it doesn't modify any of the docstrings in your actual
source code files.
.. _ReStructuredText: http://docutils.sourceforge.net/rst.html
.. _docstrings: http://www.python.org/dev/peps/pep-0287/