Skip to content

Commit 4f6f9d9

Browse files
committed
update the doc and api doc to 1.2b2
1 parent 668c23f commit 4f6f9d9

7 files changed

+191
-128
lines changed

Diff for: doc/manual/source/api/diffpy.Structure.Parsers.rst

+35-31
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,102 @@
1-
Parsers Package
2-
===============
1+
diffpy.Structure.Parsers package
2+
================================
33

4-
:mod:`Parsers` Package
5-
----------------------
4+
Submodules
5+
----------
66

7-
.. automodule:: diffpy.Structure.Parsers
8-
:members:
9-
:undoc-members:
10-
:show-inheritance:
11-
12-
:mod:`P_auto` Module
13-
--------------------
7+
diffpy.Structure.Parsers.P_auto module
8+
--------------------------------------
149

1510
.. automodule:: diffpy.Structure.Parsers.P_auto
1611
:members:
1712
:undoc-members:
1813
:show-inheritance:
1914

20-
:mod:`P_bratoms` Module
21-
-----------------------
15+
diffpy.Structure.Parsers.P_bratoms module
16+
-----------------------------------------
2217

2318
.. automodule:: diffpy.Structure.Parsers.P_bratoms
2419
:members:
2520
:undoc-members:
2621
:show-inheritance:
2722

28-
:mod:`P_cif` Module
29-
-------------------
23+
diffpy.Structure.Parsers.P_cif module
24+
-------------------------------------
3025

3126
.. automodule:: diffpy.Structure.Parsers.P_cif
3227
:members:
3328
:undoc-members:
3429
:show-inheritance:
3530

36-
:mod:`P_discus` Module
37-
----------------------
31+
diffpy.Structure.Parsers.P_discus module
32+
----------------------------------------
3833

3934
.. automodule:: diffpy.Structure.Parsers.P_discus
4035
:members:
4136
:undoc-members:
4237
:show-inheritance:
4338

44-
:mod:`P_pdb` Module
45-
-------------------
39+
diffpy.Structure.Parsers.P_pdb module
40+
-------------------------------------
4641

4742
.. automodule:: diffpy.Structure.Parsers.P_pdb
4843
:members:
4944
:undoc-members:
5045
:show-inheritance:
5146

52-
:mod:`P_pdffit` Module
53-
----------------------
47+
diffpy.Structure.Parsers.P_pdffit module
48+
----------------------------------------
5449

5550
.. automodule:: diffpy.Structure.Parsers.P_pdffit
5651
:members:
5752
:undoc-members:
5853
:show-inheritance:
5954

60-
:mod:`P_rawxyz` Module
61-
----------------------
55+
diffpy.Structure.Parsers.P_rawxyz module
56+
----------------------------------------
6257

6358
.. automodule:: diffpy.Structure.Parsers.P_rawxyz
6459
:members:
6560
:undoc-members:
6661
:show-inheritance:
6762

68-
:mod:`P_xcfg` Module
69-
--------------------
63+
diffpy.Structure.Parsers.P_xcfg module
64+
--------------------------------------
7065

7166
.. automodule:: diffpy.Structure.Parsers.P_xcfg
7267
:members:
7368
:undoc-members:
7469
:show-inheritance:
7570

76-
:mod:`P_xyz` Module
77-
-------------------
71+
diffpy.Structure.Parsers.P_xyz module
72+
-------------------------------------
7873

7974
.. automodule:: diffpy.Structure.Parsers.P_xyz
8075
:members:
8176
:undoc-members:
8277
:show-inheritance:
8378

84-
:mod:`parser_index_mod` Module
85-
------------------------------
79+
diffpy.Structure.Parsers.parser_index_mod module
80+
------------------------------------------------
8681

8782
.. automodule:: diffpy.Structure.Parsers.parser_index_mod
8883
:members:
8984
:undoc-members:
9085
:show-inheritance:
9186

92-
:mod:`structureparser` Module
93-
-----------------------------
87+
diffpy.Structure.Parsers.structureparser module
88+
-----------------------------------------------
9489

9590
.. automodule:: diffpy.Structure.Parsers.structureparser
9691
:members:
9792
:undoc-members:
9893
:show-inheritance:
94+
95+
96+
Module contents
97+
---------------
98+
99+
.. automodule:: diffpy.Structure.Parsers
100+
:members:
101+
:undoc-members:
102+
:show-inheritance:
+15-11
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,30 @@
1-
applications Package
2-
====================
1+
diffpy.Structure.applications package
2+
=====================================
33

4-
:mod:`applications` Package
5-
---------------------------
4+
Submodules
5+
----------
66

7-
.. automodule:: diffpy.Structure.applications
7+
diffpy.Structure.applications.anyeye module
8+
-------------------------------------------
9+
10+
.. automodule:: diffpy.Structure.applications.anyeye
811
:members:
912
:undoc-members:
1013
:show-inheritance:
1114

12-
:mod:`anyeye` Module
13-
--------------------
15+
diffpy.Structure.applications.transtru module
16+
---------------------------------------------
1417

15-
.. automodule:: diffpy.Structure.applications.anyeye
18+
.. automodule:: diffpy.Structure.applications.transtru
1619
:members:
1720
:undoc-members:
1821
:show-inheritance:
1922

20-
:mod:`transtru` Module
21-
----------------------
2223

23-
.. automodule:: diffpy.Structure.applications.transtru
24+
Module contents
25+
---------------
26+
27+
.. automodule:: diffpy.Structure.applications
2428
:members:
2529
:undoc-members:
2630
:show-inheritance:

Diff for: doc/manual/source/api/diffpy.Structure.expansion.rst

+21-17
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
1-
expansion Package
2-
=================
1+
diffpy.Structure.expansion package
2+
==================================
33

4-
:mod:`expansion` Package
5-
------------------------
4+
Submodules
5+
----------
66

7-
.. automodule:: diffpy.Structure.expansion
8-
:members:
9-
:undoc-members:
10-
:show-inheritance:
11-
12-
:mod:`makeCuboctahedron` Module
13-
-------------------------------
7+
diffpy.Structure.expansion.makeCuboctahedron module
8+
---------------------------------------------------
149

1510
.. automodule:: diffpy.Structure.expansion.makeCuboctahedron
1611
:members:
1712
:undoc-members:
1813
:show-inheritance:
1914

20-
:mod:`makeEllipsoid` Module
21-
---------------------------
15+
diffpy.Structure.expansion.makeEllipsoid module
16+
-----------------------------------------------
2217

2318
.. automodule:: diffpy.Structure.expansion.makeEllipsoid
2419
:members:
2520
:undoc-members:
2621
:show-inheritance:
2722

28-
:mod:`shapeUtils` Module
29-
------------------------
23+
diffpy.Structure.expansion.shapeUtils module
24+
--------------------------------------------
3025

3126
.. automodule:: diffpy.Structure.expansion.shapeUtils
3227
:members:
3328
:undoc-members:
3429
:show-inheritance:
3530

36-
:mod:`supercell_mod` Module
37-
---------------------------
31+
diffpy.Structure.expansion.supercell_mod module
32+
-----------------------------------------------
3833

3934
.. automodule:: diffpy.Structure.expansion.supercell_mod
4035
:members:
4136
:undoc-members:
4237
:show-inheritance:
38+
39+
40+
Module contents
41+
---------------
42+
43+
.. automodule:: diffpy.Structure.expansion
44+
:members:
45+
:undoc-members:
46+
:show-inheritance:

0 commit comments

Comments
 (0)