Skip to content

Commit 720bc20

Browse files
committed
Add new api-documentation
1 parent ec78bf2 commit 720bc20

File tree

3 files changed

+61
-37
lines changed

3 files changed

+61
-37
lines changed
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:tocdepth: -1
22

3-
diffpy.morph.morph_helpers package
3+
diffpy.morph.morph-helpers package
44
==================================
55

66
.. automodule:: diffpy.morph.morph_helpers
@@ -11,18 +11,18 @@ diffpy.morph.morph_helpers package
1111
Submodules
1212
----------
1313

14-
diffpy.morph.morph_helpers.transformpdftordf module
14+
diffpy.morph.morph_helpers.transformrdftopdf module
1515
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1616

17-
.. automodule:: diffpy.morph.morph_helpers.transformpdftordf
17+
.. automodule:: diffpy.morph.morph_helpers.transformrdftopdf
1818
:members:
1919
:undoc-members:
2020
:show-inheritance:
2121

22-
diffpy.morph.morph_helpers.transformrdftopdf module
22+
diffpy.morph.morph_helpers.transformpdftordf module
2323
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2424

25-
.. automodule:: diffpy.morph.morph_helpers.transformrdftopdf
25+
.. automodule:: diffpy.morph.morph_helpers.transformpdftordf
2626
:members:
2727
:undoc-members:
2828
:show-inheritance:

doc/source/api/diffpy.morph.morphs.rst

Lines changed: 38 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,42 +11,58 @@ diffpy.morph.morphs package
1111
Submodules
1212
----------
1313

14-
diffpy.morph.morphs.morphishape module
15-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
14+
diffpy.morph.morphs.morphscale module
15+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1616

17-
.. automodule:: diffpy.morph.morphs.morphishape
17+
.. automodule:: diffpy.morph.morphs.morphscale
1818
:members:
1919
:undoc-members:
2020
:show-inheritance:
2121

22-
diffpy.morph.morphs.morphchain module
22+
diffpy.morph.morphs.morphshape module
2323
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2424

25-
.. automodule:: diffpy.morph.morphs.morphchain
25+
.. automodule:: diffpy.morph.morphs.morphshape
2626
:members:
2727
:undoc-members:
2828
:show-inheritance:
2929

30-
diffpy.morph.morphs.morphresolution module
31-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
30+
diffpy.morph.morphs.morphshift module
31+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3232

33-
.. automodule:: diffpy.morph.morphs.morphresolution
33+
.. automodule:: diffpy.morph.morphs.morphshift
3434
:members:
3535
:undoc-members:
3636
:show-inheritance:
3737

38-
diffpy.morph.morphs.morphshape module
38+
diffpy.morph.morphs.morphfuncy module
3939
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4040

41-
.. automodule:: diffpy.morph.morphs.morphshape
41+
.. automodule:: diffpy.morph.morphs.morphfuncy
4242
:members:
4343
:undoc-members:
4444
:show-inheritance:
4545

46-
diffpy.morph.morphs.morphshift module
46+
diffpy.morph.morphs.morphchain module
4747
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4848

49-
.. automodule:: diffpy.morph.morphs.morphshift
49+
.. automodule:: diffpy.morph.morphs.morphchain
50+
:members:
51+
:undoc-members:
52+
:show-inheritance:
53+
54+
diffpy.morph.morphs.morphresolution module
55+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
56+
57+
.. automodule:: diffpy.morph.morphs.morphresolution
58+
:members:
59+
:undoc-members:
60+
:show-inheritance:
61+
62+
diffpy.morph.morphs.morphstretch module
63+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
64+
65+
.. automodule:: diffpy.morph.morphs.morphstretch
5066
:members:
5167
:undoc-members:
5268
:show-inheritance:
@@ -59,34 +75,34 @@ diffpy.morph.morphs.morph module
5975
:undoc-members:
6076
:show-inheritance:
6177

62-
diffpy.morph.morphs.morphrgrid module
63-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
78+
diffpy.morph.morphs.morphsqueeze module
79+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6480

65-
.. automodule:: diffpy.morph.morphs.morphrgrid
81+
.. automodule:: diffpy.morph.morphs.morphsqueeze
6682
:members:
6783
:undoc-members:
6884
:show-inheritance:
6985

70-
diffpy.morph.morphs.morphsmear module
86+
diffpy.morph.morphs.morphrgrid module
7187
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7288

73-
.. automodule:: diffpy.morph.morphs.morphsmear
89+
.. automodule:: diffpy.morph.morphs.morphrgrid
7490
:members:
7591
:undoc-members:
7692
:show-inheritance:
7793

78-
diffpy.morph.morphs.morphstretch module
79-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
94+
diffpy.morph.morphs.morphishape module
95+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8096

81-
.. automodule:: diffpy.morph.morphs.morphstretch
97+
.. automodule:: diffpy.morph.morphs.morphishape
8298
:members:
8399
:undoc-members:
84100
:show-inheritance:
85101

86-
diffpy.morph.morphs.morphscale module
102+
diffpy.morph.morphs.morphsmear module
87103
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
88104

89-
.. automodule:: diffpy.morph.morphs.morphscale
105+
.. automodule:: diffpy.morph.morphs.morphsmear
90106
:members:
91107
:undoc-members:
92108
:show-inheritance:

doc/source/api/diffpy.morph.rst

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Subpackages
1414
.. toctree::
1515
:titlesonly:
1616

17-
diffpy.morph.morphs
1817
diffpy.morph.morph_helpers
18+
diffpy.morph.morphs
1919

2020
Submodules
2121
----------
@@ -36,18 +36,18 @@ diffpy.morph.morph_api module
3636
:undoc-members:
3737
:show-inheritance:
3838

39-
diffpy.morph.refine module
40-
^^^^^^^^^^^^^^^^^^^^^^^^^^
39+
diffpy.morph.tools module
40+
^^^^^^^^^^^^^^^^^^^^^^^^^
4141

42-
.. automodule:: diffpy.morph.refine
42+
.. automodule:: diffpy.morph.tools
4343
:members:
4444
:undoc-members:
4545
:show-inheritance:
4646

47-
diffpy.morph.tools module
48-
^^^^^^^^^^^^^^^^^^^^^^^^^
47+
diffpy.morph.morphpy module
48+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
4949

50-
.. automodule:: diffpy.morph.tools
50+
.. automodule:: diffpy.morph.morphpy
5151
:members:
5252
:undoc-members:
5353
:show-inheritance:
@@ -60,10 +60,10 @@ diffpy.morph.morph_io module
6060
:undoc-members:
6161
:show-inheritance:
6262

63-
diffpy.morph.log module
64-
^^^^^^^^^^^^^^^^^^^^^^^
63+
diffpy.morph.refine module
64+
^^^^^^^^^^^^^^^^^^^^^^^^^^
6565

66-
.. automodule:: diffpy.morph.log
66+
.. automodule:: diffpy.morph.refine
6767
:members:
6868
:undoc-members:
6969
:show-inheritance:
@@ -75,3 +75,11 @@ diffpy.morph.morphapp module
7575
:members:
7676
:undoc-members:
7777
:show-inheritance:
78+
79+
diffpy.morph.log module
80+
^^^^^^^^^^^^^^^^^^^^^^^
81+
82+
.. automodule:: diffpy.morph.log
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:

0 commit comments

Comments
 (0)