@@ -11,15 +11,15 @@ of them in third-party projects.
11
11
12
12
The following extensions are available:
13
13
14
- - ``numpydoc ``: support for the Numpy docstring format in Sphinx, and add
15
- the code description directives ``np:function ``, ``np-c:function ``, etc.
16
- that support the Numpy docstring syntax.
14
+ - ``numpydoc ``: support for the Numpy docstring format in Sphinx, and add
15
+ the code description directives ``np:function ``, ``np-c:function ``, etc.
16
+ that support the Numpy docstring syntax.
17
17
18
- - ``numpydoc.traitsdoc ``: For gathering documentation about Traits attributes.
18
+ - ``numpydoc.traitsdoc ``: For gathering documentation about Traits attributes.
19
19
20
- - ``numpydoc.plot_directive ``: Adaptation of Matplotlib's ``plot:: ``
21
- directive. Note that this implementation may still undergo severe
22
- changes or eventually be deprecated.
20
+ - ``numpydoc.plot_directive ``: Adaptation of Matplotlib's ``plot:: ``
21
+ directive. Note that this implementation may still undergo severe
22
+ changes or eventually be deprecated.
23
23
24
24
See `A Guide to NumPy/SciPy Documentation <https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt >`_
25
25
for how to write docs that use this extension.
@@ -36,30 +36,30 @@ Options
36
36
37
37
The following options can be set in conf.py:
38
38
39
- - numpydoc_use_plots: bool
39
+ - `` numpydoc_use_plots `` : bool
40
40
41
41
Whether to produce ``plot:: `` directives for Examples sections that
42
42
contain ``import matplotlib ``.
43
43
44
- - numpydoc_show_class_members: bool
44
+ - `` numpydoc_show_class_members `` : bool
45
45
46
46
Whether to show all members of a class in the Methods and Attributes
47
47
sections automatically.
48
48
``True `` by default.
49
49
50
- - numpydoc_show_inherited_class_members: bool
50
+ - `` numpydoc_show_inherited_class_members `` : bool
51
51
52
52
Whether to show all inherited members of a class in the Methods and Attributes
53
53
sections automatically. If it's false, inherited members won't shown.
54
54
``True `` by default.
55
55
56
- - numpydoc_class_members_toctree: bool
56
+ - `` numpydoc_class_members_toctree `` : bool
57
57
58
58
Whether to create a Sphinx table of contents for the lists of class
59
59
methods and attributes. If a table of contents is made, Sphinx expects
60
60
each entry to have a separate page.
61
61
``True `` by default.
62
62
63
- - numpydoc_edit_link: bool (DEPRECATED -- edit your HTML template instead)
63
+ - `` numpydoc_edit_link `` : bool (DEPRECATED -- edit your HTML template instead)
64
64
65
65
Whether to insert an edit link after docstrings.
0 commit comments