Skip to content

Commit 5d4accf

Browse files
docs: initial commit
1 parent 8ef887c commit 5d4accf

File tree

5 files changed

+37
-0
lines changed

5 files changed

+37
-0
lines changed
File renamed without changes.

doc/examples/examples.rst

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. _Examples:
2+
3+
:tocdepth: -1
4+
5+
Examples
6+
########
7+
Landing page for diffpy.labpdfproc examples.
8+
9+
.. toctree::
10+
functions_example

doc/examples/functions_example.rst

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. _Functions Example:
2+
3+
:tocdepth: -1
4+
5+
Functions Example
6+
#################
7+
8+
This example will demonstrate how to use ``diffpy.labpdfproc.functions`` modules to apply absorption correction to their intensity data.
9+
10+
1)

doc/utilities/functions_utility.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. _Functions Utility:
2+
3+
Functions Utility
4+
=================

doc/utilities/utilities.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _Utilities:
2+
3+
:tocdepth: -1
4+
5+
Utilities
6+
#########
7+
Overview of utilities offered by ``diffpy.labpdfproc``.
8+
Check the :ref:`examples<Examples>` provided for how to use these.
9+
10+
.. contents::
11+
:depth: 2
12+
13+
.. include:: functions_utility.rst

0 commit comments

Comments
 (0)