Skip to content

Commit 9696402

Browse files
authored
build doc (#174)
* build doc * pre commit
1 parent 1ae626d commit 9696402

10 files changed

+771
-100
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
:tocdepth: -1
2+
3+
diffpy.pdfgui.applications package
4+
==================================
5+
6+
.. automodule:: diffpy.pdfgui.applications
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
10+
11+
Submodules
12+
----------
13+
14+
diffpy.pdfgui.applications.pdfgui module
15+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16+
17+
.. automodule:: diffpy.pdfgui.applications.pdfgui
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
:tocdepth: -1
2+
3+
diffpy.pdfgui.control package
4+
=============================
5+
6+
.. automodule:: diffpy.pdfgui.control
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
10+
11+
Submodules
12+
----------
13+
14+
diffpy.pdfgui.control.pdfcomponent module
15+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16+
17+
.. automodule:: diffpy.pdfgui.control.pdfcomponent
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
22+
diffpy.pdfgui.control.constraint module
23+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
24+
25+
.. automodule:: diffpy.pdfgui.control.constraint
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
diffpy.pdfgui.control.controlerrors module
31+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
32+
33+
.. automodule:: diffpy.pdfgui.control.controlerrors
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+
38+
diffpy.pdfgui.control.pdflist module
39+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
40+
41+
.. automodule:: diffpy.pdfgui.control.pdflist
42+
:members:
43+
:undoc-members:
44+
:show-inheritance:
45+
46+
diffpy.pdfgui.control.pdfguimacros module
47+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
48+
49+
.. automodule:: diffpy.pdfgui.control.pdfguimacros
50+
:members:
51+
:undoc-members:
52+
:show-inheritance:
53+
54+
diffpy.pdfgui.control.calculation module
55+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
56+
57+
.. automodule:: diffpy.pdfgui.control.calculation
58+
:members:
59+
:undoc-members:
60+
:show-inheritance:
61+
62+
diffpy.pdfgui.control.pdfstructure module
63+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
64+
65+
.. automodule:: diffpy.pdfgui.control.pdfstructure
66+
:members:
67+
:undoc-members:
68+
:show-inheritance:
69+
70+
diffpy.pdfgui.control.fitdataset module
71+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
72+
73+
.. automodule:: diffpy.pdfgui.control.fitdataset
74+
:members:
75+
:undoc-members:
76+
:show-inheritance:
77+
78+
diffpy.pdfgui.control.structureviewer module
79+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
80+
81+
.. automodule:: diffpy.pdfgui.control.structureviewer
82+
:members:
83+
:undoc-members:
84+
:show-inheritance:
85+
86+
diffpy.pdfgui.control.plotter module
87+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
88+
89+
.. automodule:: diffpy.pdfgui.control.plotter
90+
:members:
91+
:undoc-members:
92+
:show-inheritance:
93+
94+
diffpy.pdfgui.control.fitstructure module
95+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
96+
97+
.. automodule:: diffpy.pdfgui.control.fitstructure
98+
:members:
99+
:undoc-members:
100+
:show-inheritance:
101+
102+
diffpy.pdfgui.control.fitting module
103+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
104+
105+
.. automodule:: diffpy.pdfgui.control.fitting
106+
:members:
107+
:undoc-members:
108+
:show-inheritance:
109+
110+
diffpy.pdfgui.control.pdfguicontrol module
111+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
112+
113+
.. automodule:: diffpy.pdfgui.control.pdfguicontrol
114+
:members:
115+
:undoc-members:
116+
:show-inheritance:
117+
118+
diffpy.pdfgui.control.parameter module
119+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
120+
121+
.. automodule:: diffpy.pdfgui.control.parameter
122+
:members:
123+
:undoc-members:
124+
:show-inheritance:
125+
126+
diffpy.pdfgui.control.pdfdataset module
127+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
128+
129+
.. automodule:: diffpy.pdfgui.control.pdfdataset
130+
:members:
131+
:undoc-members:
132+
:show-inheritance:
133+
134+
diffpy.pdfgui.control.organizer module
135+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
136+
137+
.. automodule:: diffpy.pdfgui.control.organizer
138+
:members:
139+
:undoc-members:
140+
:show-inheritance:

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

Lines changed: 0 additions & 31 deletions
This file was deleted.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
:tocdepth: -1
2+
3+
diffpy.pdfgui.gui.design package
4+
================================
5+
6+
.. automodule:: diffpy.pdfgui.gui.design
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

0 commit comments

Comments
 (0)