Skip to content

Commit 2eaa983

Browse files
committed
Add cross-links
1 parent 17bc20a commit 2eaa983

File tree

7 files changed

+43
-413
lines changed

7 files changed

+43
-413
lines changed

doc/source/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424
except Exception:
2525
fullversion = "No version found. The correct version will appear in the released version." # noqa: E501
2626

27+
# Import modules referenced in documentation (resolves `WARNING: autodoc: failed to import module`)
28+
autodoc_mock_imports = [
29+
"diffpy.utils",
30+
]
31+
2732
# If extensions (or modules to document with autodoc) are in another directory,
2833
# add these directories to sys.path here. If the directory is relative to the
2934
# documentation root, use Path().resolve() to make it absolute, like shown here. # noqa: E501

doc/source/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Finally, we note that though ``diffpy.morph`` should work on other spectra
4040
that are not PDFs, it has not been extensively tested beyond the PDF.
4141

4242
To get started, please visit the :ref:`quick_start`.
43+
For those looking to see more advanced features, you can visit
4344

4445
=======
4546
Authors
@@ -72,6 +73,8 @@ Table of contents
7273
:titlesonly:
7374

7475
quickstart
76+
tutorials
77+
morphpy
7578
license
7679
release
7780
Package API <api/diffpy.morph>

doc/source/morphpy.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
Using diffpy.morph in Python
44
############################
55

6-
On top of the command-line usage described in the `quickstart tutorial <quickstart.html>`__,
6+
On top of the command-line (CLI) usage described in the `quickstart tutorial <quickstart.html>`__,
77
``diffpy.morph`` also supports Python integration.
8-
This functionality is intended for those acquainted with the basic morphs
8+
All functionality supported on the CLI is also available for Python.
9+
This page is intended for those acquainted with the basic morphs
910
described in the aforementioned quickstart tutorial who want to use ``diffpy.morph`` in their
1011
Python scripts.
1112

@@ -249,4 +250,4 @@ As you can see, the fitted scale and offset values match the ones used
249250
to generate the target (scale=20 & offset=0.8). This example shows how
250251
``MorphFuncy`` can be used to fit and apply custom transformations. Now
251252
it's your turn to experiment with other custom functions that may be useful
252-
for analyzing your data.
253+
for analyzing your data.

doc/source/quickstart.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _quick_start:
22

3-
diffpy.morph Quickstart Tutorial
4-
################################
3+
Quickstart
4+
##########
55

66
Welcome! This will be a quick tutorial to accquaint users with ``diffpy.morph``
77
and some of what it can do on the command-line.

0 commit comments

Comments
 (0)