Skip to content

Commit 8ac06ea

Browse files
committed
DOC: merge API docs in modules.rst
No need for separate `pyobjcryst` document.
1 parent 78d2d22 commit 8ac06ea

File tree

3 files changed

+133
-140
lines changed

3 files changed

+133
-140
lines changed

doc/manual/source/api/modules.rst

Lines changed: 132 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,134 @@
1-
pyobjcryst
2-
==========
1+
:tocdepth: 2
32

4-
.. toctree::
5-
:maxdepth: 4
3+
##############
4+
pyobjcryst API
5+
##############
66

7-
pyobjcryst
7+
8+
pyobjcryst module
9+
-----------------
10+
11+
.. automodule:: pyobjcryst
12+
:members:
13+
:undoc-members:
14+
:show-inheritance:
15+
16+
pyobjcryst.atom module
17+
----------------------
18+
19+
.. automodule:: pyobjcryst.atom
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
pyobjcryst.crystal module
25+
-------------------------
26+
27+
.. automodule:: pyobjcryst.crystal
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:
31+
32+
pyobjcryst.general module
33+
-------------------------
34+
35+
.. automodule:: pyobjcryst.general
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:
39+
40+
pyobjcryst.io module
41+
--------------------
42+
43+
.. automodule:: pyobjcryst.io
44+
:members:
45+
:undoc-members:
46+
:show-inheritance:
47+
48+
pyobjcryst.molecule module
49+
--------------------------
50+
51+
.. automodule:: pyobjcryst.molecule
52+
:members:
53+
:undoc-members:
54+
:show-inheritance:
55+
56+
pyobjcryst.polyhedron module
57+
----------------------------
58+
59+
.. automodule:: pyobjcryst.polyhedron
60+
:members:
61+
:undoc-members:
62+
:show-inheritance:
63+
64+
pyobjcryst.refinableobj module
65+
------------------------------
66+
67+
.. automodule:: pyobjcryst.refinableobj
68+
:members:
69+
:undoc-members:
70+
:show-inheritance:
71+
72+
pyobjcryst.scatterer module
73+
---------------------------
74+
75+
.. automodule:: pyobjcryst.scatterer
76+
:members:
77+
:undoc-members:
78+
:show-inheritance:
79+
80+
pyobjcryst.scatteringpower module
81+
---------------------------------
82+
83+
.. automodule:: pyobjcryst.scatteringpower
84+
:members:
85+
:undoc-members:
86+
:show-inheritance:
87+
88+
pyobjcryst.scatteringpowersphere module
89+
---------------------------------------
90+
91+
.. automodule:: pyobjcryst.scatteringpowersphere
92+
:members:
93+
:undoc-members:
94+
:show-inheritance:
95+
96+
pyobjcryst.spacegroup module
97+
----------------------------
98+
99+
.. automodule:: pyobjcryst.spacegroup
100+
:members:
101+
:undoc-members:
102+
:show-inheritance:
103+
104+
pyobjcryst.unitcell module
105+
--------------------------
106+
107+
.. automodule:: pyobjcryst.unitcell
108+
:members:
109+
:undoc-members:
110+
:show-inheritance:
111+
112+
pyobjcryst.utils module
113+
-----------------------
114+
115+
.. automodule:: pyobjcryst.utils
116+
:members:
117+
:undoc-members:
118+
:show-inheritance:
119+
120+
pyobjcryst.version module
121+
-------------------------
122+
123+
.. automodule:: pyobjcryst.version
124+
:members:
125+
:undoc-members:
126+
:show-inheritance:
127+
128+
pyobjcryst.zscatterer module
129+
----------------------------
130+
131+
.. automodule:: pyobjcryst.zscatterer
132+
:members:
133+
:undoc-members:
134+
:show-inheritance:

doc/manual/source/api/pyobjcryst.rst

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

doc/manual/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Table of contents
3737
:titlesonly:
3838

3939
license
40-
api/modules.rst
40+
api/modules
4141

4242
========================================================================
4343
Indices

0 commit comments

Comments
 (0)