Skip to content

Commit 0130500

Browse files
committed
update doc and api doc 1.1b1
1 parent 93e2a1f commit 0130500

File tree

6 files changed

+68
-117
lines changed

6 files changed

+68
-117
lines changed

Diff for: doc/manual/source/api/diffpy.rst

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

4-
:mod:`diffpy` Package
5-
---------------------
6-
74
Subpackages
85
-----------
96

107
.. toctree::
118

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

Diff for: doc/manual/source/api/diffpy.utils.parsers.rst

+15-11
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,30 @@
1-
parsers Package
2-
===============
1+
diffpy.utils.parsers package
2+
============================
33

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

7-
.. automodule:: diffpy.utils.parsers
7+
diffpy.utils.parsers.loaddata module
8+
------------------------------------
9+
10+
.. automodule:: diffpy.utils.parsers.loaddata
811
:members:
912
:undoc-members:
1013
:show-inheritance:
1114

12-
:mod:`loaddata` Module
13-
----------------------
15+
diffpy.utils.parsers.resample module
16+
------------------------------------
1417

15-
.. automodule:: diffpy.utils.parsers.loaddata
18+
.. automodule:: diffpy.utils.parsers.resample
1619
:members:
1720
:undoc-members:
1821
:show-inheritance:
1922

20-
:mod:`resample` Module
21-
----------------------
2223

23-
.. automodule:: diffpy.utils.parsers.resample
24+
Module contents
25+
---------------
26+
27+
.. automodule:: diffpy.utils.parsers
2428
:members:
2529
:undoc-members:
2630
:show-inheritance:

Diff for: doc/manual/source/api/diffpy.utils.rst

+22-10
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
1-
utils Package
2-
=============
3-
4-
:mod:`utils` Package
5-
--------------------
6-
7-
.. automodule:: diffpy.utils
8-
:members:
9-
:undoc-members:
10-
:show-inheritance:
1+
diffpy.utils package
2+
====================
113

124
Subpackages
135
-----------
@@ -16,3 +8,23 @@ Subpackages
168

179
diffpy.utils.parsers
1810
diffpy.utils.wx
11+
12+
Submodules
13+
----------
14+
15+
diffpy.utils.version module
16+
---------------------------
17+
18+
.. automodule:: diffpy.utils.version
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
24+
Module contents
25+
---------------
26+
27+
.. automodule:: diffpy.utils
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:

Diff for: doc/manual/source/api/diffpy.utils.wx.rst

+12-8
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
1-
wx Package
2-
==========
1+
diffpy.utils.wx package
2+
=======================
33

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

7-
.. automodule:: diffpy.utils.wx
7+
diffpy.utils.wx.gridutils module
8+
--------------------------------
9+
10+
.. automodule:: diffpy.utils.wx.gridutils
811
:members:
912
:undoc-members:
1013
:show-inheritance:
1114

12-
:mod:`gridutils` Module
13-
-----------------------
1415

15-
.. automodule:: diffpy.utils.wx.gridutils
16+
Module contents
17+
---------------
18+
19+
.. automodule:: diffpy.utils.wx
1620
:members:
1721
:undoc-members:
1822
:show-inheritance:

Diff for: doc/manual/source/index.rst

+10-18
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,18 @@ Last updated |today|.
1414

1515
diffpy.utils - general purpose shared utilities for the diffpy libraries.
1616

17-
The diffpy.utils package provides functions to easily find and load data from
18-
text files, various utilites related to data parsing and manipulation, and a set
19-
of common functions for grid manipulation used by the GUI front-end
20-
diffpy.pdfgui.
21-
22-
The data loading utilities can be used with most automatically generated powder
23-
diffraction and PDF data files. They work by searching for matrix blocks of
24-
data containing a constant number of columns and a pre-set minimum number of
25-
rows. By default all columns will be read and returned as a multi-dimensional
26-
numpy array or as a tuple of individual columns; a sub-set of columns can also
27-
be selected to be read and the rest ignored.
28-
29-
The data manipulation tools contains interpolation functions that can be used to
30-
resample a PDF or other profile function over a new grid. Interpolation is based
31-
on the Whittaker-Shannon formula.
17+
The diffpy.utils package provides functions for extracting array data from
18+
variously formatted text files and wx GUI utilities used by the PDFgui
19+
program. The package also includes interpolation function based on the
20+
Whittaker-Shannon formula that can be used to resample a PDF or other profile
21+
function over a new grid.
3222

3323

3424
===================
3525
Disclaimer
3626
===================
3727

38-
.. include:: ../../../LICENSE.txt
28+
.. literalinclude:: ../../../LICENSE.txt
3929

4030
================
4131
Acknowledgments
@@ -52,10 +42,12 @@ diffpy.Structure is developed and maintained by
5242
Installation
5343
======================================
5444

55-
.. include:: install.rst
45+
See the `README.rst <https://github.com/diffpy/diffpy.utils#requirements>`_
46+
file included with the distribution.
5647

48+
======================================
5749
API and Index
58-
==================
50+
======================================
5951

6052
.. toctree::
6153
:maxdepth: 3

Diff for: doc/manual/source/install.rst

-66
This file was deleted.

0 commit comments

Comments
 (0)