Skip to content

Commit b50e629

Browse files
generate package api doc
1 parent 5542651 commit b50e629

File tree

3 files changed

+42
-40
lines changed

3 files changed

+42
-40
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
:tocdepth: -1
2+
3+
diffpy.labpdfproc.data package
4+
==============================
5+
6+
.. automodule:: diffpy.labpdfproc.data
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
10+

doc/source/api/diffpy.labpdfproc.example_package.rst

Lines changed: 0 additions & 31 deletions
This file was deleted.

doc/source/api/diffpy.labpdfproc.rst

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
:tocdepth: -1
22

3-
|title|
4-
=======
5-
6-
.. |title| replace:: diffpy.labpdfproc package
3+
diffpy.labpdfproc package
4+
=========================
75

86
.. automodule:: diffpy.labpdfproc
97
:members:
@@ -14,17 +12,42 @@ Subpackages
1412
-----------
1513

1614
.. toctree::
17-
diffpy.labpdfproc.example_package
15+
:titlesonly:
16+
17+
diffpy.labpdfproc.data
1818

1919
Submodules
2020
----------
2121

22-
|module|
23-
--------
22+
diffpy.labpdfproc.functions module
23+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2424

25-
.. |module| replace:: diffpy.labpdfproc.example_submodule module
25+
.. automodule:: diffpy.labpdfproc.functions
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
2629

27-
.. automodule:: diffpy.labpdfproc.example_submodule
30+
diffpy.labpdfproc.tools module
31+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
32+
33+
.. automodule:: diffpy.labpdfproc.tools
2834
:members:
2935
:undoc-members:
3036
:show-inheritance:
37+
38+
diffpy.labpdfproc.mud_calculator module
39+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
40+
41+
.. automodule:: diffpy.labpdfproc.mud_calculator
42+
:members:
43+
:undoc-members:
44+
:show-inheritance:
45+
46+
diffpy.labpdfproc.labpdfprocapp module
47+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
48+
49+
.. automodule:: diffpy.labpdfproc.labpdfprocapp
50+
:members:
51+
:undoc-members:
52+
:show-inheritance:
53+

0 commit comments

Comments
 (0)