diff options
| author | shimizukawa <shimizukawa@gmail.com> | 2014-04-28 19:41:14 +0900 |
|---|---|---|
| committer | shimizukawa <shimizukawa@gmail.com> | 2014-04-28 19:41:14 +0900 |
| commit | 79462980ff1832dc7ebdbebbbeb9739e16654401 (patch) | |
| tree | 3361f9a2a3ae856147144c9f1daa6a9359604e94 | |
| parent | e30dc4285938de9f77dd12dc69ddce6b0e8a4d2a (diff) | |
| download | sphinx-79462980ff1832dc7ebdbebbbeb9739e16654401.tar.gz | |
tiny documentation fix
| -rw-r--r-- | doc/ext/napoleon.rst | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/doc/ext/napoleon.rst b/doc/ext/napoleon.rst index 0eae4045..7248e491 100644 --- a/doc/ext/napoleon.rst +++ b/doc/ext/napoleon.rst @@ -38,7 +38,7 @@ according to the `Google Python Style Guide`_:: Much more legible, no? -Napoleon is a `Sphinx extension`_ that enables Sphinx to parse both `NumPy`_ +Napoleon is a :doc:`../extensions` 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 @@ -61,7 +61,7 @@ source code files. Getting Started --------------- -1. After `setting up Sphinx`_ to build your docs, enable napoleon in the +1. After :doc:`setting up Sphinx <../tutorial>` to build your docs, enable napoleon in the Sphinx `conf.py` file:: # conf.py @@ -73,7 +73,6 @@ Getting Started $ sphinx-apidoc -f -o docs/source projectdir -.. _setting up Sphinx: http://sphinx-doc.org/tutorial.html Docstrings ---------- |