Skip to content

Commit be8d5ac

Browse files
rgommerspv
authored andcommitted
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 795239d commit be8d5ac

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,30 +28,30 @@ Options
2828

2929
The following options can be set in conf.py:
3030

31-
- numpydoc_use_plots: bool
31+
- ``numpydoc_use_plots``: bool
3232

3333
Whether to produce ``plot::`` directives for Examples sections that
3434
contain ``import matplotlib``.
3535

36-
- numpydoc_show_class_members: bool
36+
- ``numpydoc_show_class_members``: bool
3737

3838
Whether to show all members of a class in the Methods and Attributes
3939
sections automatically.
4040
``True`` by default.
4141

42-
- numpydoc_show_inherited_class_members: bool
42+
- ``numpydoc_show_inherited_class_members``: bool
4343

4444
Whether to show all inherited members of a class in the Methods and Attributes
4545
sections automatically. If it's false, inherited members won't shown.
4646
``True`` by default.
4747

48-
- numpydoc_class_members_toctree: bool
48+
- ``numpydoc_class_members_toctree``: bool
4949

5050
Whether to create a Sphinx table of contents for the lists of class
5151
methods and attributes. If a table of contents is made, Sphinx expects
5252
each entry to have a separate page.
5353
``True`` by default.
5454

55-
- numpydoc_edit_link: bool (DEPRECATED -- edit your HTML template instead)
55+
- ``numpydoc_edit_link``: bool (DEPRECATED -- edit your HTML template instead)
5656

5757
Whether to insert an edit link after docstrings.

0 commit comments

Comments
 (0)