Skip to content

Commit 0d5e895

Browse files
TieqiongTieqiong
committed
API
1 parent 06ead97 commit 0d5e895

6 files changed

Lines changed: 287 additions & 40 deletions

‎doc/source/api/diffpy.structure.applications.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
:tocdepth: -1
2+
3+
diffpy.structure.applications package
4+
=====================================
5+
6+
.. automodule:: diffpy.structure.applications
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
10+
11+
Submodules
12+
----------
13+
14+
diffpy.structure.applications.transtru module
15+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16+
17+
.. automodule:: diffpy.structure.applications.transtru
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
22+
diffpy.structure.applications.anyeye module
23+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
24+
25+
.. automodule:: diffpy.structure.applications.anyeye
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
:tocdepth: -1
2+
3+
diffpy.structure.apps package
4+
=============================
5+
6+
.. automodule:: diffpy.structure.apps
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
10+
11+
Submodules
12+
----------
13+
14+
diffpy.structure.apps.transtru module
15+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16+
17+
.. automodule:: diffpy.structure.apps.transtru
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
22+
diffpy.structure.apps.anyeye module
23+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
24+
25+
.. automodule:: diffpy.structure.apps.anyeye
26+
:members:
27+
:undoc-members:
28+
: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: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
:tocdepth: -1
2+
3+
diffpy.structure.expansion package
4+
==================================
5+
6+
.. automodule:: diffpy.structure.expansion
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
10+
11+
Submodules
12+
----------
13+
14+
diffpy.structure.expansion.shapeutils module
15+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16+
17+
.. automodule:: diffpy.structure.expansion.shapeutils
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
22+
diffpy.structure.expansion.makeellipsoid module
23+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
24+
25+
.. automodule:: diffpy.structure.expansion.makeellipsoid
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
diffpy.structure.expansion.supercell_mod module
31+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
32+
33+
.. automodule:: diffpy.structure.expansion.supercell_mod
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+

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

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
:tocdepth: -1
2+
3+
diffpy.structure.parsers package
4+
================================
5+
6+
.. automodule:: diffpy.structure.parsers
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
10+
11+
Submodules
12+
----------
13+
14+
diffpy.structure.parsers.p_rawxyz module
15+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16+
17+
.. automodule:: diffpy.structure.parsers.p_rawxyz
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
22+
diffpy.structure.parsers.structureparser module
23+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
24+
25+
.. automodule:: diffpy.structure.parsers.structureparser
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
diffpy.structure.parsers.p_cif module
31+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
32+
33+
.. automodule:: diffpy.structure.parsers.p_cif
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+
38+
diffpy.structure.parsers.p_auto module
39+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
40+
41+
.. automodule:: diffpy.structure.parsers.p_auto
42+
:members:
43+
:undoc-members:
44+
:show-inheritance:
45+
46+
diffpy.structure.parsers.p_pdffit module
47+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
48+
49+
.. automodule:: diffpy.structure.parsers.p_pdffit
50+
:members:
51+
:undoc-members:
52+
:show-inheritance:
53+
54+
diffpy.structure.parsers.p_xcfg module
55+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
56+
57+
.. automodule:: diffpy.structure.parsers.p_xcfg
58+
:members:
59+
:undoc-members:
60+
:show-inheritance:
61+
62+
diffpy.structure.parsers.parser_index_mod module
63+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
64+
65+
.. automodule:: diffpy.structure.parsers.parser_index_mod
66+
:members:
67+
:undoc-members:
68+
:show-inheritance:
69+
70+
diffpy.structure.parsers.p_pdb module
71+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
72+
73+
.. automodule:: diffpy.structure.parsers.p_pdb
74+
:members:
75+
:undoc-members:
76+
:show-inheritance:
77+
78+
diffpy.structure.parsers.p_discus module
79+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
80+
81+
.. automodule:: diffpy.structure.parsers.p_discus
82+
:members:
83+
:undoc-members:
84+
:show-inheritance:
85+
86+
diffpy.structure.parsers.p_xyz module
87+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
88+
89+
.. automodule:: diffpy.structure.parsers.p_xyz
90+
:members:
91+
:undoc-members:
92+
:show-inheritance:
93+

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

Lines changed: 99 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,109 @@ Subpackages
1412
-----------
1513

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

1922
Submodules
2023
----------
2124

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

25-
.. |module| replace:: diffpy.structure.example_submodule module
33+
diffpy.structure._legacy_importer module
34+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2635

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

0 commit comments

Comments
 (0)