Skip to content

Commit e9f6532

Browse files
committed
MAINT: update ReST formatting in README.
Related to missing README content on https://pypi.python.org/pypi/numpydoc/0.7.0 Doesn't help fix that, but at least this file now looks like valid ReST.
1 parent 057ef57 commit e9f6532

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ of them in third-party projects.
1111

1212
The following extensions are available:
1313

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.
1717

18-
- ``numpydoc.traitsdoc``: For gathering documentation about Traits attributes.
18+
- ``numpydoc.traitsdoc``: For gathering documentation about Traits attributes.
1919

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.
2323

2424
See `A Guide to NumPy/SciPy Documentation <https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_
2525
for how to write docs that use this extension.
@@ -36,30 +36,30 @@ Options
3636

3737
The following options can be set in conf.py:
3838

39-
- numpydoc_use_plots: bool
39+
- ``numpydoc_use_plots``: bool
4040

4141
Whether to produce ``plot::`` directives for Examples sections that
4242
contain ``import matplotlib``.
4343

44-
- numpydoc_show_class_members: bool
44+
- ``numpydoc_show_class_members``: bool
4545

4646
Whether to show all members of a class in the Methods and Attributes
4747
sections automatically.
4848
``True`` by default.
4949

50-
- numpydoc_show_inherited_class_members: bool
50+
- ``numpydoc_show_inherited_class_members``: bool
5151

5252
Whether to show all inherited members of a class in the Methods and Attributes
5353
sections automatically. If it's false, inherited members won't shown.
5454
``True`` by default.
5555

56-
- numpydoc_class_members_toctree: bool
56+
- ``numpydoc_class_members_toctree``: bool
5757

5858
Whether to create a Sphinx table of contents for the lists of class
5959
methods and attributes. If a table of contents is made, Sphinx expects
6060
each entry to have a separate page.
6161
``True`` by default.
6262

63-
- numpydoc_edit_link: bool (DEPRECATED -- edit your HTML template instead)
63+
- ``numpydoc_edit_link``: bool (DEPRECATED -- edit your HTML template instead)
6464

6565
Whether to insert an edit link after docstrings.

0 commit comments

Comments
 (0)