Skip to content

Commit 77c5957

Browse files
committed
docs: generate docs with auto api
1 parent 9ce1769 commit 77c5957

File tree

3 files changed

+34
-17
lines changed

3 files changed

+34
-17
lines changed

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

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,6 @@ diffpy.utils.parsers package
1111
Submodules
1212
----------
1313

14-
diffpy.utils.parsers.serialization module
15-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16-
17-
.. automodule:: diffpy.utils.parsers.serialization
18-
:members:
19-
:undoc-members:
20-
:show-inheritance:
21-
2214
diffpy.utils.parsers.loaddata module
2315
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2416

@@ -34,3 +26,12 @@ diffpy.utils.parsers.custom_exceptions module
3426
:members:
3527
:undoc-members:
3628
:show-inheritance:
29+
30+
diffpy.utils.parsers.serialization module
31+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
32+
33+
.. automodule:: diffpy.utils.parsers.serialization
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+

doc/source/api/diffpy.utils.rst

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,40 +16,55 @@ Subpackages
1616

1717
diffpy.utils.parsers
1818
diffpy.utils.wx
19-
diffpy.utils.scattering_objects
2019

2120
Submodules
2221
----------
2322

24-
diffpy.utils.tools module
25-
^^^^^^^^^^^^^^^^^^^^^^^^^
23+
diffpy.utils.transforms module
24+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2625

27-
.. automodule:: diffpy.utils.tools
26+
.. automodule:: diffpy.utils.transforms
2827
:members:
2928
:undoc-members:
3029
:show-inheritance:
3130

32-
diffpy.utils.resampler module
33-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
31+
diffpy.utils.validators module
32+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3433

35-
.. automodule:: diffpy.utils.resampler
34+
.. automodule:: diffpy.utils.validators
3635
:members:
3736
:undoc-members:
3837
:show-inheritance:
3938

39+
diffpy.utils.tools module
40+
^^^^^^^^^^^^^^^^^^^^^^^^^
41+
42+
.. automodule:: diffpy.utils.tools
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
4046

4147
diffpy.utils.user_config module
42-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
48+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4349

4450
.. automodule:: diffpy.utils.user_config
4551
:members:
4652
:undoc-members:
4753
:show-inheritance:
4854

4955
diffpy.utils.diffraction_objects module
50-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
56+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5157

5258
.. automodule:: diffpy.utils.diffraction_objects
5359
:members:
5460
:undoc-members:
5561
:show-inheritance:
62+
63+
diffpy.utils.resampler module
64+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
65+
66+
.. automodule:: diffpy.utils.resampler
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+

doc/source/api/diffpy.utils.wx.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@ diffpy.utils.wx.gridutils module
1818
:members:
1919
:undoc-members:
2020
:show-inheritance:
21+

0 commit comments

Comments
 (0)