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

tiny documentation fix

Browse Source
This commit is contained in:
Takayuki Shimizukawa 2014-04-28 19:41:14 +09:00
parent 7f710be021
commit 638458038d
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/ext/napoleon.rst
View File

@ -38,7 +38,7 @@ according to the `Google Python Style Guide`_::
Much more legible, no? 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`_. and `Google`_ style docstrings - the style recommended by `Khan Academy`_.
Napoleon is a pre-processor that parses `NumPy`_ and `Google`_ style Napoleon is a pre-processor that parses `NumPy`_ and `Google`_ style
@ -61,7 +61,7 @@ source code files.
Getting Started 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:: Sphinx `conf.py` file::
# conf.py # conf.py
@ -73,7 +73,6 @@ Getting Started
$ sphinx-apidoc -f -o docs/source projectdir $ sphinx-apidoc -f -o docs/source projectdir
.. _setting up Sphinx: http://sphinx-doc.org/tutorial.html
Docstrings Docstrings
---------- ----------