Skip to content

Commit eb87061

Browse files
committed
DOC: clean up autogenerated API docs
* start with module summary * remove extra headings
1 parent ebce4d5 commit eb87061

File tree

4 files changed

+20
-32
lines changed

4 files changed

+20
-32
lines changed
Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
diffpy.utils.parsers package
22
============================
33

4-
Submodules
5-
----------
4+
.. automodule:: diffpy.utils.parsers
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
68

79
diffpy.utils.parsers.loaddata module
810
------------------------------------
@@ -19,12 +21,3 @@ diffpy.utils.parsers.resample module
1921
:members:
2022
:undoc-members:
2123
:show-inheritance:
22-
23-
24-
Module contents
25-
---------------
26-
27-
.. automodule:: diffpy.utils.parsers
28-
:members:
29-
:undoc-members:
30-
:show-inheritance:

doc/manual/source/api/diffpy.utils.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
1+
:tocdepth: 2
2+
13
diffpy.utils package
24
====================
35

6+
.. automodule:: diffpy.utils
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
10+
411
Subpackages
512
-----------
613

@@ -19,12 +26,3 @@ diffpy.utils.version module
1926
:members:
2027
:undoc-members:
2128
:show-inheritance:
22-
23-
24-
Module contents
25-
---------------
26-
27-
.. automodule:: diffpy.utils
28-
:members:
29-
:undoc-members:
30-
:show-inheritance:
Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,15 @@
11
diffpy.utils.wx package
22
=======================
33

4-
Submodules
5-
----------
6-
7-
diffpy.utils.wx.gridutils module
8-
--------------------------------
9-
10-
.. automodule:: diffpy.utils.wx.gridutils
4+
.. automodule:: diffpy.utils.wx
115
:members:
126
:undoc-members:
137
:show-inheritance:
148

9+
diffpy.utils.wx.gridutils module
10+
--------------------------------
1511

16-
Module contents
17-
---------------
18-
19-
.. automodule:: diffpy.utils.wx
12+
.. automodule:: diffpy.utils.wx.gridutils
2013
:members:
2114
:undoc-members:
2215
:show-inheritance:

doc/manual/source/index.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,11 @@ Table of contents
4040

4141
license
4242
release
43-
api/diffpy.utils.rst
43+
Package API <api/diffpy.utils>
44+
45+
======================================
46+
Indices
47+
======================================
4448

4549
* :ref:`genindex`
4650
* :ref:`search`

0 commit comments

Comments
 (0)