Skip to content

Commit 4cccb7a

Browse files
committed
Add api generated docs
1 parent 2e992d9 commit 4cccb7a

File tree

5 files changed

+101
-40
lines changed

5 files changed

+101
-40
lines changed

doc/source/api/diffpy.structure.apps.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,4 @@ diffpy.structure.apps.anyeye module
2626
:members:
2727
:undoc-members:
2828
:show-inheritance:
29+

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

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

doc/source/api/diffpy.structure.expansion.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,4 @@ diffpy.structure.expansion.supercell_mod module
3434
:members:
3535
:undoc-members:
3636
:show-inheritance:
37+

doc/source/api/diffpy.structure.parsers.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,4 @@ diffpy.structure.parsers.p_xyz module
9090
:members:
9191
:undoc-members:
9292
:show-inheritance:
93+
Lines changed: 98 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.structure package
3+
diffpy.structure package
4+
========================
75

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

1614
.. toctree::
17-
diffpy.structure.example_package
15+
:titlesonly:
16+
17+
diffpy.structure.parsers
18+
diffpy.structure.expansion
19+
diffpy.structure.apps
1820

1921
Submodules
2022
----------
2123

22-
|module|
23-
--------
24+
diffpy.structure.spacegroups module
25+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
26+
27+
.. automodule:: diffpy.structure.spacegroups
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:
2431

25-
.. |module| replace:: diffpy.structure.example_submodule module
32+
diffpy.structure._legacy_importer module
33+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2634

27-
.. automodule:: diffpy.structure.example_submodule
35+
.. automodule:: diffpy.structure._legacy_importer
2836
:members:
2937
:undoc-members:
3038
:show-inheritance:
39+
40+
diffpy.structure.structureerrors module
41+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
42+
43+
.. automodule:: diffpy.structure.structureerrors
44+
:members:
45+
:undoc-members:
46+
:show-inheritance:
47+
48+
diffpy.structure.spacegroupmod module
49+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
50+
51+
.. automodule:: diffpy.structure.spacegroupmod
52+
:members:
53+
:undoc-members:
54+
:show-inheritance:
55+
56+
diffpy.structure.utils module
57+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
58+
59+
.. automodule:: diffpy.structure.utils
60+
:members:
61+
:undoc-members:
62+
:show-inheritance:
63+
64+
diffpy.structure.lattice module
65+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
66+
67+
.. automodule:: diffpy.structure.lattice
68+
:members:
69+
:undoc-members:
70+
:show-inheritance:
71+
72+
diffpy.structure.structure module
73+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
74+
75+
.. automodule:: diffpy.structure.structure
76+
:members:
77+
:undoc-members:
78+
:show-inheritance:
79+
80+
diffpy.structure.mmlibspacegroups module
81+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
82+
83+
.. automodule:: diffpy.structure.mmlibspacegroups
84+
:members:
85+
:undoc-members:
86+
:show-inheritance:
87+
88+
diffpy.structure.symmetryutilities module
89+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
90+
91+
.. automodule:: diffpy.structure.symmetryutilities
92+
:members:
93+
:undoc-members:
94+
:show-inheritance:
95+
96+
diffpy.structure.atom module
97+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
98+
99+
.. automodule:: diffpy.structure.atom
100+
:members:
101+
:undoc-members:
102+
:show-inheritance:
103+
104+
diffpy.structure.pdffitstructure module
105+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
106+
107+
.. automodule:: diffpy.structure.pdffitstructure
108+
:members:
109+
:undoc-members:
110+
:show-inheritance:
111+
112+
diffpy.structure.sgtbxspacegroups module
113+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
114+
115+
.. automodule:: diffpy.structure.sgtbxspacegroups
116+
:members:
117+
:undoc-members:
118+
:show-inheritance:
119+

0 commit comments

Comments
 (0)