Skip to content

Commit fca001f

Browse files
committed
Refinements to readme and format conclusion
1 parent 52661dc commit fca001f

File tree

2 files changed

+10
-49
lines changed

2 files changed

+10
-49
lines changed

README.rst

Lines changed: 8 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
.. image:: https://travis-ci.org/numpy/numpydoc.png?branch=master
22
:target: https://travis-ci.org/numpy/numpydoc/
33

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+
410
=====================================
511
numpydoc -- Numpy's Sphinx extensions
612
=====================================
@@ -21,45 +27,8 @@ The following extensions are available:
2127
directive. Note that this implementation may still undergo severe
2228
changes or eventually be deprecated.
2329

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>`_
3032

3133
Numpydoc inserts a hook into Sphinx's autodoc that converts docstrings
3234
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.

doc/format.rst

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -620,16 +620,8 @@ followed.
620620
Conclusion
621621
----------
622622

623-
`An example <http://github.com/numpy/numpy/blob/master/doc/example.py>`_ of the
624-
format shown here is available. Refer to `How to Build API/Reference
625-
Documentation
626-
<http://github.com/numpy/numpy/blob/master/doc/HOWTO_BUILD_DOCS.rst.txt>`_
627-
on how to use Sphinx_ to build the manual.
628-
629-
This document itself was written in ReStructuredText, and may be converted to
630-
HTML using::
631-
632-
$ rst2html HOWTO_DOCUMENT.txt HOWTO_DOCUMENT.html
623+
This document itself was written in ReStructuredText.
624+
:ref:`An example <example>` of the format shown here is available.
633625

634626
.. _SciPy: http://www.scipy.org
635627
.. _numpy-discussion list: http://scipy.org/scipylib/mailing-lists.html

0 commit comments

Comments
 (0)