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

Fix link to NumPy Docstring Standard

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez 2021-07-08 22:34:25 +02:00
parent 785d6f9618
commit 8531f20eb7
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/usage/extensions/autodoc.rst
View File

@ -41,7 +41,7 @@ you can also enable the :mod:`napoleon <sphinx.ext.napoleon>` extension.
docstrings to correct reStructuredText before :mod:`autodoc` processes them.
.. _Google: https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings
.. _NumPy: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
.. _NumPy: https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
Directives

4
doc/usage/extensions/example_numpy.py
View File

@ -37,8 +37,8 @@ module_level_variable1 : int
with it.
.. _NumPy Documentation HOWTO:
https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
.. _NumPy docstring standard:
https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
"""

2
sphinx/ext/napoleon/__init__.py
View File

@ -49,7 +49,7 @@ class Config:
.. _Google style:
https://google.github.io/styleguide/pyguide.html
.. _NumPy style:
https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
Attributes
----------