diff options
author | Rob Ruana <rob@relentlessidiot.com> | 2014-04-26 19:43:46 -0400 |
---|---|---|
committer | Rob Ruana <rob@relentlessidiot.com> | 2014-04-26 19:43:46 -0400 |
commit | e30dc4285938de9f77dd12dc69ddce6b0e8a4d2a (patch) | |
tree | 75ebf3a2eeb787388ba3f7c183724601d9722bbc | |
parent | 708a9ecbb0e0e7caf94a617a77efc3e7b01d64de (diff) | |
download | sphinx-e30dc4285938de9f77dd12dc69ddce6b0e8a4d2a.tar.gz |
Updates Napoleon documentation per suggestion by a user
-rw-r--r-- | doc/ext/napoleon.rst | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/doc/ext/napoleon.rst b/doc/ext/napoleon.rst index 9dda29c6..0eae4045 100644 --- a/doc/ext/napoleon.rst +++ b/doc/ext/napoleon.rst @@ -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/ |