Skip to content

Commit 2c0a59b

Browse files
XiaohaoYangXiaohaoYang
committed
update doc and api doc to 1.0b4-1, move all (examples).rst to one
directory
1 parent 0c19150 commit 2c0a59b

35 files changed

+435
-310
lines changed

‎doc/manual/source/api/diffpy.rst

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
diffpy Package
1+
diffpy package
22
==============
33

44
Subpackages
@@ -8,3 +8,10 @@ Subpackages
88

99
diffpy.srfit
1010

11+
Module contents
12+
---------------
13+
14+
.. automodule:: diffpy
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:

‎doc/manual/source/api/diffpy.srfit.equation.literals.rst

+20-17
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,46 @@
1-
literals Package
2-
================
1+
diffpy.srfit.equation.literals package
2+
======================================
33

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

7-
.. automodule:: diffpy.srfit.equation.literals
8-
:members:
9-
:undoc-members:
10-
:show-inheritance:
11-
12-
:mod:`abcs` Module
13-
------------------
7+
diffpy.srfit.equation.literals.abcs module
8+
------------------------------------------
149

1510
.. automodule:: diffpy.srfit.equation.literals.abcs
1611
:members:
1712
:undoc-members:
1813
:show-inheritance:
1914

20-
:mod:`argument` Module
21-
----------------------
15+
diffpy.srfit.equation.literals.argument module
16+
----------------------------------------------
2217

2318
.. automodule:: diffpy.srfit.equation.literals.argument
2419
:members:
2520
:undoc-members:
2621
:show-inheritance:
2722

28-
:mod:`literal` Module
29-
---------------------
23+
diffpy.srfit.equation.literals.literal module
24+
---------------------------------------------
3025

3126
.. automodule:: diffpy.srfit.equation.literals.literal
3227
:members:
3328
:undoc-members:
3429
:show-inheritance:
3530

36-
:mod:`operators` Module
37-
-----------------------
31+
diffpy.srfit.equation.literals.operators module
32+
-----------------------------------------------
3833

3934
.. automodule:: diffpy.srfit.equation.literals.operators
4035
:members:
4136
:undoc-members:
4237
:show-inheritance:
4338

39+
40+
Module contents
41+
---------------
42+
43+
.. automodule:: diffpy.srfit.equation.literals
44+
:members:
45+
:undoc-members:
46+
:show-inheritance:

‎doc/manual/source/api/diffpy.srfit.equation.rst

+21-18
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,38 @@
1-
equation Package
2-
================
1+
diffpy.srfit.equation package
2+
=============================
33

4-
:mod:`equation` Package
5-
-----------------------
4+
Subpackages
5+
-----------
66

7-
.. automodule:: diffpy.srfit.equation
8-
:members:
9-
:undoc-members:
10-
:show-inheritance:
7+
.. toctree::
8+
9+
diffpy.srfit.equation.literals
10+
diffpy.srfit.equation.visitors
11+
12+
Submodules
13+
----------
1114

12-
:mod:`builder` Module
13-
---------------------
15+
diffpy.srfit.equation.builder module
16+
------------------------------------
1417

1518
.. automodule:: diffpy.srfit.equation.builder
1619
:members:
1720
:undoc-members:
1821
:show-inheritance:
1922

20-
:mod:`equationmod` Module
21-
-------------------------
23+
diffpy.srfit.equation.equationmod module
24+
----------------------------------------
2225

2326
.. automodule:: diffpy.srfit.equation.equationmod
2427
:members:
2528
:undoc-members:
2629
:show-inheritance:
2730

28-
Subpackages
29-
-----------
3031

31-
.. toctree::
32-
33-
diffpy.srfit.equation.literals
34-
diffpy.srfit.equation.visitors
32+
Module contents
33+
---------------
3534

35+
.. automodule:: diffpy.srfit.equation
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:

‎doc/manual/source/api/diffpy.srfit.equation.visitors.rst

+22-19
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,54 @@
1-
visitors Package
2-
================
1+
diffpy.srfit.equation.visitors package
2+
======================================
33

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

7-
.. automodule:: diffpy.srfit.equation.visitors
8-
:members:
9-
:undoc-members:
10-
:show-inheritance:
11-
12-
:mod:`argfinder` Module
13-
-----------------------
7+
diffpy.srfit.equation.visitors.argfinder module
8+
-----------------------------------------------
149

1510
.. automodule:: diffpy.srfit.equation.visitors.argfinder
1611
:members:
1712
:undoc-members:
1813
:show-inheritance:
1914

20-
:mod:`printer` Module
21-
---------------------
15+
diffpy.srfit.equation.visitors.printer module
16+
---------------------------------------------
2217

2318
.. automodule:: diffpy.srfit.equation.visitors.printer
2419
:members:
2520
:undoc-members:
2621
:show-inheritance:
2722

28-
:mod:`swapper` Module
29-
---------------------
23+
diffpy.srfit.equation.visitors.swapper module
24+
---------------------------------------------
3025

3126
.. automodule:: diffpy.srfit.equation.visitors.swapper
3227
:members:
3328
:undoc-members:
3429
:show-inheritance:
3530

36-
:mod:`validator` Module
37-
-----------------------
31+
diffpy.srfit.equation.visitors.validator module
32+
-----------------------------------------------
3833

3934
.. automodule:: diffpy.srfit.equation.visitors.validator
4035
:members:
4136
:undoc-members:
4237
:show-inheritance:
4338

44-
:mod:`visitor` Module
45-
---------------------
39+
diffpy.srfit.equation.visitors.visitor module
40+
---------------------------------------------
4641

4742
.. automodule:: diffpy.srfit.equation.visitors.visitor
4843
:members:
4944
:undoc-members:
5045
:show-inheritance:
5146

47+
48+
Module contents
49+
---------------
50+
51+
.. automodule:: diffpy.srfit.equation.visitors
52+
:members:
53+
:undoc-members:
54+
:show-inheritance:

‎doc/manual/source/api/diffpy.srfit.fitbase.rst

+44-41
Original file line numberDiff line numberDiff line change
@@ -1,139 +1,142 @@
1-
fitbase Package
2-
===============
1+
diffpy.srfit.fitbase package
2+
============================
33

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

7-
.. automodule:: diffpy.srfit.fitbase
8-
:members:
9-
:undoc-members:
10-
:show-inheritance:
11-
12-
:mod:`calculator` Module
13-
------------------------
7+
diffpy.srfit.fitbase.calculator module
8+
--------------------------------------
149

1510
.. automodule:: diffpy.srfit.fitbase.calculator
1611
:members:
1712
:undoc-members:
1813
:show-inheritance:
1914

20-
:mod:`configurable` Module
21-
--------------------------
15+
diffpy.srfit.fitbase.configurable module
16+
----------------------------------------
2217

2318
.. automodule:: diffpy.srfit.fitbase.configurable
2419
:members:
2520
:undoc-members:
2621
:show-inheritance:
2722

28-
:mod:`constraint` Module
29-
------------------------
23+
diffpy.srfit.fitbase.constraint module
24+
--------------------------------------
3025

3126
.. automodule:: diffpy.srfit.fitbase.constraint
3227
:members:
3328
:undoc-members:
3429
:show-inheritance:
3530

36-
:mod:`fitcontribution` Module
37-
-----------------------------
31+
diffpy.srfit.fitbase.fitcontribution module
32+
-------------------------------------------
3833

3934
.. automodule:: diffpy.srfit.fitbase.fitcontribution
4035
:members:
4136
:undoc-members:
4237
:show-inheritance:
4338

44-
:mod:`fithook` Module
45-
---------------------
39+
diffpy.srfit.fitbase.fithook module
40+
-----------------------------------
4641

4742
.. automodule:: diffpy.srfit.fitbase.fithook
4843
:members:
4944
:undoc-members:
5045
:show-inheritance:
5146

52-
:mod:`fitrecipe` Module
53-
-----------------------
47+
diffpy.srfit.fitbase.fitrecipe module
48+
-------------------------------------
5449

5550
.. automodule:: diffpy.srfit.fitbase.fitrecipe
5651
:members:
5752
:undoc-members:
5853
:show-inheritance:
5954

60-
:mod:`fitresults` Module
61-
------------------------
55+
diffpy.srfit.fitbase.fitresults module
56+
--------------------------------------
6257

6358
.. automodule:: diffpy.srfit.fitbase.fitresults
6459
:members:
6560
:undoc-members:
6661
:show-inheritance:
6762

68-
:mod:`parameter` Module
69-
-----------------------
63+
diffpy.srfit.fitbase.parameter module
64+
-------------------------------------
7065

7166
.. automodule:: diffpy.srfit.fitbase.parameter
7267
:members:
7368
:undoc-members:
7469
:show-inheritance:
7570

76-
:mod:`parameterset` Module
77-
--------------------------
71+
diffpy.srfit.fitbase.parameterset module
72+
----------------------------------------
7873

7974
.. automodule:: diffpy.srfit.fitbase.parameterset
8075
:members:
8176
:undoc-members:
8277
:show-inheritance:
8378

84-
:mod:`profile` Module
85-
---------------------
79+
diffpy.srfit.fitbase.profile module
80+
-----------------------------------
8681

8782
.. automodule:: diffpy.srfit.fitbase.profile
8883
:members:
8984
:undoc-members:
9085
:show-inheritance:
9186

92-
:mod:`profilegenerator` Module
93-
------------------------------
87+
diffpy.srfit.fitbase.profilegenerator module
88+
--------------------------------------------
9489

9590
.. automodule:: diffpy.srfit.fitbase.profilegenerator
9691
:members:
9792
:undoc-members:
9893
:show-inheritance:
9994

100-
:mod:`profileparser` Module
101-
---------------------------
95+
diffpy.srfit.fitbase.profileparser module
96+
-----------------------------------------
10297

10398
.. automodule:: diffpy.srfit.fitbase.profileparser
10499
:members:
105100
:undoc-members:
106101
:show-inheritance:
107102

108-
:mod:`recipeorganizer` Module
109-
-----------------------------
103+
diffpy.srfit.fitbase.recipeorganizer module
104+
-------------------------------------------
110105

111106
.. automodule:: diffpy.srfit.fitbase.recipeorganizer
112107
:members:
113108
:undoc-members:
114109
:show-inheritance:
115110

116-
:mod:`restraint` Module
117-
-----------------------
111+
diffpy.srfit.fitbase.restraint module
112+
-------------------------------------
118113

119114
.. automodule:: diffpy.srfit.fitbase.restraint
120115
:members:
121116
:undoc-members:
122117
:show-inheritance:
123118

124-
:mod:`simplerecipe` Module
125-
--------------------------
119+
diffpy.srfit.fitbase.simplerecipe module
120+
----------------------------------------
126121

127122
.. automodule:: diffpy.srfit.fitbase.simplerecipe
128123
:members:
129124
:undoc-members:
130125
:show-inheritance:
131126

132-
:mod:`validatable` Module
133-
-------------------------
127+
diffpy.srfit.fitbase.validatable module
128+
---------------------------------------
134129

135130
.. automodule:: diffpy.srfit.fitbase.validatable
136131
:members:
137132
:undoc-members:
138133
:show-inheritance:
139134

135+
136+
Module contents
137+
---------------
138+
139+
.. automodule:: diffpy.srfit.fitbase
140+
:members:
141+
:undoc-members:
142+
:show-inheritance:

0 commit comments

Comments
 (0)