1
1
.. image :: https://travis-ci.org/numpy/numpydoc.png?branch=master
2
2
:target: https://travis-ci.org/numpy/numpydoc/
3
3
4
+ .. |docs | image :: https://readthedocs.org/projects/numpydoc/badge/?version=latest
5
+ :alt: Documentation Status
6
+ :scale: 100%
7
+ :target: https://numpydoc.readthedocs.io/en/latest/?badge=latest
8
+
9
+
4
10
=====================================
5
11
numpydoc -- Numpy's Sphinx extensions
6
12
=====================================
@@ -21,45 +27,8 @@ The following extensions are available:
21
27
directive. Note that this implementation may still undergo severe
22
28
changes or eventually be deprecated.
23
29
24
- See `A Guide to NumPy/SciPy Documentation <https://github.com/numpy/numpydoc/blob/master/doc/format.rst >`_
25
- for how to write docs that use this extension.
26
-
27
-
28
- numpydoc
29
- ========
30
+ See `numpydoc docstring guide <https://numpydoc.readthedocs.io/latest/en/format.html >`_
31
+ for how to write docs that use this extension, and the `user guide <https://numpydoc.readthedocs.io >`_
30
32
31
33
Numpydoc inserts a hook into Sphinx's autodoc that converts docstrings
32
34
following the Numpy/Scipy format to a form palatable to Sphinx.
33
-
34
- Options
35
- -------
36
-
37
- The following options can be set in conf.py:
38
-
39
- - numpydoc_use_plots: bool
40
-
41
- Whether to produce ``plot:: `` directives for Examples sections that
42
- contain ``import matplotlib ``.
43
-
44
- - numpydoc_show_class_members: bool
45
-
46
- Whether to show all members of a class in the Methods and Attributes
47
- sections automatically.
48
- ``True `` by default.
49
-
50
- - numpydoc_show_inherited_class_members: bool
51
-
52
- Whether to show all inherited members of a class in the Methods and Attributes
53
- sections automatically. If it's false, inherited members won't shown.
54
- ``True `` by default.
55
-
56
- - numpydoc_class_members_toctree: bool
57
-
58
- Whether to create a Sphinx table of contents for the lists of class
59
- methods and attributes. If a table of contents is made, Sphinx expects
60
- each entry to have a separate page.
61
- ``True `` by default.
62
-
63
- - numpydoc_edit_link: bool (DEPRECATED -- edit your HTML template instead)
64
-
65
- Whether to insert an edit link after docstrings.
0 commit comments