Skip to content

Commit c9a4d39

Browse files
committed
docs: add submodules in api/pyobjcryst.rst
1 parent 26e2bd0 commit c9a4d39

File tree

2 files changed

+194
-40
lines changed

2 files changed

+194
-40
lines changed

docs/source/api/pyobjcryst.example_package.rst

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

docs/source/api/pyobjcryst.rst

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

13-
Subpackages
14-
-----------
15-
16-
.. toctree::
17-
pyobjcryst.example_package
1813

1914
Submodules
2015
----------
2116

22-
|module|
23-
--------
17+
pyobjcryst.atom module
18+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
19+
20+
.. automodule:: pyobjcryst.atom
21+
:members:
22+
:undoc-members:
23+
:show-inheritance:
24+
25+
pyobjcryst.crystal module
26+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
27+
28+
.. automodule:: pyobjcryst.crystal
29+
:members:
30+
:undoc-members:
31+
:show-inheritance:
32+
33+
pyobjcryst.diffractiondatasinglecrystal module
34+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
35+
36+
.. automodule:: pyobjcryst.diffractiondatasinglecrystal
37+
:members:
38+
:undoc-members:
39+
:show-inheritance:
40+
41+
pyobjcryst.fourier module
42+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
43+
44+
.. automodule:: pyobjcryst.fourier
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:
48+
49+
pyobjcryst.general module
50+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
51+
52+
.. automodule:: pyobjcryst.general
53+
:members:
54+
:undoc-members:
55+
:show-inheritance:
56+
57+
pyobjcryst.globaloptim module
58+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
59+
60+
.. automodule:: pyobjcryst.globaloptim
61+
:members:
62+
:undoc-members:
63+
:show-inheritance:
64+
65+
pyobjcryst.globals module
66+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
67+
68+
.. automodule:: pyobjcryst.globals
69+
:members:
70+
:undoc-members:
71+
:show-inheritance:
72+
73+
pyobjcryst.indexing module
74+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
75+
76+
.. automodule:: pyobjcryst.indexing
77+
:members:
78+
:undoc-members:
79+
:show-inheritance:
80+
81+
pyobjcryst.io module
82+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
83+
84+
.. automodule:: pyobjcryst.io
85+
:members:
86+
:undoc-members:
87+
:show-inheritance:
88+
89+
pyobjcryst.lsq module
90+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
91+
92+
.. automodule:: pyobjcryst.lsq
93+
:members:
94+
:undoc-members:
95+
:show-inheritance:
96+
97+
pyobjcryst.molecule module
98+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
99+
100+
.. automodule:: pyobjcryst.molecule
101+
:members:
102+
:undoc-members:
103+
:show-inheritance:
104+
105+
pyobjcryst.polyhedron module
106+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
107+
108+
.. automodule:: pyobjcryst.polyhedron
109+
:members:
110+
:undoc-members:
111+
:show-inheritance:
112+
113+
pyobjcryst.powderpattern module
114+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
115+
116+
.. automodule:: pyobjcryst.powderpattern
117+
:members:
118+
:undoc-members:
119+
:show-inheritance:
120+
121+
pyobjcryst.pyobjcryst_app module
122+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
123+
124+
.. automodule:: pyobjcryst.pyobjcryst_app
125+
:members:
126+
:undoc-members:
127+
:show-inheritance:
128+
129+
pyobjcryst.radiation module
130+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
131+
132+
.. automodule:: pyobjcryst.radiation
133+
:members:
134+
:undoc-members:
135+
:show-inheritance:
136+
137+
pyobjcryst.refineableobj module
138+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
139+
140+
.. automodule:: pyobjcryst.refineableobj
141+
:members:
142+
:undoc-members:
143+
:show-inheritance:
144+
145+
pyobjcryst.scatterer module
146+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
147+
148+
.. automodule:: pyobjcryst.scatterer
149+
:members:
150+
:undoc-members:
151+
:show-inheritance:
152+
153+
pyobjcryst.scatteringdata module
154+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
155+
156+
.. automodule:: pyobjcryst.scatteringdata
157+
:members:
158+
:undoc-members:
159+
:show-inheritance:
160+
161+
pyobjcryst.scatteringpower module
162+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
163+
164+
.. automodule:: pyobjcryst.scatteringpower
165+
:members:
166+
:undoc-members:
167+
:show-inheritance:
168+
169+
pyobjcryst.scatteringpowersphere module
170+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
171+
172+
.. automodule:: pyobjcryst.scatteringpowersphere
173+
:members:
174+
:undoc-members:
175+
:show-inheritance:
176+
177+
pyobjcryst.spacegroup module
178+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
179+
180+
.. automodule:: pyobjcryst.spacegroup
181+
:members:
182+
:undoc-members:
183+
:show-inheritance:
184+
185+
pyobjcryst.unitcell module
186+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
187+
188+
.. automodule:: pyobjcryst.unitcell
189+
:members:
190+
:undoc-members:
191+
:show-inheritance:
192+
193+
pyobjcryst.utils module
194+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
195+
196+
.. automodule:: pyobjcryst.utils
197+
:members:
198+
:undoc-members:
199+
:show-inheritance:
200+
201+
pyobjcryst.version module
202+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
203+
204+
.. automodule:: pyobjcryst.version
205+
:members:
206+
:undoc-members:
207+
:show-inheritance:
24208

25-
.. |module| replace:: pyobjcryst.example_submodule module
209+
pyobjcryst.zscatterer module
210+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
26211

27-
.. automodule:: pyobjcryst.example_submodule
212+
.. automodule:: pyobjcryst.zscatterer
28213
:members:
29214
:undoc-members:
30215
:show-inheritance:

0 commit comments

Comments
 (0)