Skip to content

Commit a9312a0

Browse files
committed
API doc success
1 parent 12b09f9 commit a9312a0

3 files changed

Lines changed: 53 additions & 45 deletions

File tree

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

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

doc/source/api/diffpy.snmf.rst

Lines changed: 52 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,68 @@
11
:tocdepth: -1
22

3-
|title|
4-
=======
5-
6-
.. |title| replace:: diffpy.snmf package
3+
diffpy.snmf package
4+
===================
75

86
.. automodule:: diffpy.snmf
97
:members:
108
:undoc-members:
119
:show-inheritance:
1210

13-
Subpackages
14-
-----------
15-
16-
.. toctree::
17-
diffpy.snmf.example_package
18-
1911
Submodules
2012
----------
2113

22-
|module|
23-
--------
14+
diffpy.snmf.subroutines module
15+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16+
17+
.. automodule:: diffpy.snmf.subroutines
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
22+
diffpy.snmf.containers module
23+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
24+
25+
.. automodule:: diffpy.snmf.containers
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
diffpy.snmf.io module
31+
^^^^^^^^^^^^^^^^^^^^^
32+
33+
.. automodule:: diffpy.snmf.io
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+
38+
diffpy.snmf.polynomials module
39+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
40+
41+
.. automodule:: diffpy.snmf.polynomials
42+
:members:
43+
:undoc-members:
44+
:show-inheritance:
45+
46+
diffpy.snmf.optimizers module
47+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
48+
49+
.. automodule:: diffpy.snmf.optimizers
50+
:members:
51+
:undoc-members:
52+
:show-inheritance:
53+
54+
diffpy.snmf.factorizers module
55+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
56+
57+
.. automodule:: diffpy.snmf.factorizers
58+
:members:
59+
:undoc-members:
60+
:show-inheritance:
2461

25-
.. |module| replace:: diffpy.snmf.example_submodule module
62+
diffpy.snmf.stretchednmfapp module
63+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2664

27-
.. automodule:: diffpy.snmf.example_submodule
65+
.. automodule:: diffpy.snmf.stretchednmfapp
2866
:members:
2967
:undoc-members:
3068
:show-inheritance:

doc/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ To get started, please go to :ref:`quick_start`
6666

6767
license
6868
release
69+
Package API <api/diffpy.snmf>
6970

7071
.. include:: ../../CHANGELOG.rst
7172

0 commit comments

Comments
 (0)