Skip to content

Commit e5d79f6

Browse files
committed
docs: fix package API documentation
1 parent 371f992 commit e5d79f6

File tree

2 files changed

+131
-41
lines changed

2 files changed

+131
-41
lines changed

docs/source/api/diffpy.srreal.example_package.rst

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

docs/source/api/diffpy.srreal.rst

Lines changed: 131 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,142 @@
1010
:undoc-members:
1111
:show-inheritance:
1212

13-
Subpackages
14-
-----------
15-
16-
.. toctree::
17-
diffpy.srreal.example_package
18-
1913
Submodules
2014
----------
2115

22-
|module|
23-
--------
16+
diffpy.srreal.atomradiitable module
17+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
18+
19+
.. automodule:: diffpy.srreal.atomradiitable
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
25+
diffpy.srreal.attributes module
26+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
27+
28+
.. automodule:: diffpy.srreal.attributes
29+
:members:
30+
:undoc-members:
31+
:show-inheritance:
32+
33+
diffpy.srreal.bondcalculator module
34+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
35+
36+
.. automodule:: diffpy.srreal.bondcalculator
37+
:members:
38+
:undoc-members:
39+
:show-inheritance:
40+
41+
diffpy.srreal.bvparameterstable module
42+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
43+
44+
.. automodule:: diffpy.srreal.bvparameterstable
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:
48+
49+
diffpy.srreal.bvscalculator module
50+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
51+
52+
.. automodule:: diffpy.srreal.bvscalculator
53+
:members:
54+
:undoc-members:
55+
:show-inheritance:
56+
57+
diffpy.srreal.eventticker module
58+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
59+
60+
.. automodule:: diffpy.srreal.eventticker
61+
:members:
62+
:undoc-members:
63+
:show-inheritance:
64+
65+
diffpy.srreal.overlapcalculator module
66+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
67+
68+
.. automodule:: diffpy.srreal.overlapcalculator
69+
:members:
70+
:undoc-members:
71+
:show-inheritance:
72+
73+
diffpy.srreal.overlapcalculator module
74+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
75+
76+
.. automodule:: diffpy.srreal.overlapcalculator
77+
:members:
78+
:undoc-members:
79+
:show-inheritance:
80+
81+
diffpy.srreal.pairquantity module
82+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
83+
84+
.. automodule:: diffpy.srreal.pairquantity
85+
:members:
86+
:undoc-members:
87+
:show-inheritance:
88+
89+
diffpy.srreal.parallel module
90+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
91+
92+
.. automodule:: diffpy.srreal.parallel
93+
:members:
94+
:undoc-members:
95+
:show-inheritance:
96+
97+
diffpy.srreal.pdfbaseline module
98+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
99+
100+
.. automodule:: diffpy.srreal.pdfbaseline
101+
:members:
102+
:undoc-members:
103+
:show-inheritance:
104+
105+
diffpy.srreal.pdfcalculator module
106+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
107+
108+
.. automodule:: diffpy.srreal.pdfcalculator
109+
:members:
110+
:undoc-members:
111+
:show-inheritance:
112+
113+
diffpy.srreal.pdfenvelope module
114+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
115+
116+
.. automodule:: diffpy.srreal.pdfenvelope
117+
:members:
118+
:undoc-members:
119+
:show-inheritance:
120+
121+
diffpy.srreal.peakprofile module
122+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
123+
124+
.. automodule:: diffpy.srreal.peakprofile
125+
:members:
126+
:undoc-members:
127+
:show-inheritance:
128+
129+
diffpy.srreal.peakwidthmodel module
130+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
131+
132+
.. automodule:: diffpy.srreal.peakwidthmodel
133+
:members:
134+
:undoc-members:
135+
:show-inheritance:
136+
137+
diffpy.srreal.scatteringfactortable module
138+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
139+
140+
.. automodule:: diffpy.srreal.scatteringfactortable
141+
:members:
142+
:undoc-members:
143+
:show-inheritance:
24144

25-
.. |module| replace:: diffpy.srreal.example_submodule module
145+
diffpy.srreal.sfaverage module
146+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
26147

27-
.. automodule:: diffpy.srreal.example_submodule
148+
.. automodule:: diffpy.srreal.sfaverage
28149
:members:
29150
:undoc-members:
30151
:show-inheritance:

0 commit comments

Comments
 (0)