Skip to content

Commit f51ac3e

Browse files
committed
chore: use correct path to CHANGELOG.rst
1 parent 18ac7ed commit f51ac3e

3 files changed

Lines changed: 31 additions & 4 deletions

File tree

docs/source/api/diffpy.srfit.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
:tocdepth: -1
2+
3+
|title|
4+
=======
5+
6+
.. |title| replace:: diffpy.srfit package
7+
8+
.. automodule:: diffpy.srfit
9+
:members:
10+
:undoc-members:
11+
:show-inheritance:
12+
13+
Subpackages
14+
-----------
15+
16+
.. toctree::
17+
diffpy.srfit.equation
18+
diffpy.srfit.equation.literals
19+
diffpy.srfit.equation.visitors
20+
diffpy.srfit.fitbase
21+
diffpy.srfit.interface
22+
diffpy.srfit.pdf
23+
diffpy.srfit.sas
24+
diffpy.srfit.structure
25+
diffpy.srfit.util

docs/source/extending.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ external program before or after interfacing with SrFit. An example of a
180180
customized Profile is the ``SASProfile`` class in the
181181
``diffpy.srfit.sas.sasprofile`` module:
182182

183-
.. literalinclude:: ../../../src/diffpy/srfit/sas/sasprofile.py
183+
.. literalinclude:: /../../src/diffpy/srfit/sas/sasprofile.py
184184
:pyobject: SASProfile
185185

186186
The ``__init__`` method sets the ``xobs``, ``yobs`` and ``dyobs`` attributes of
@@ -218,7 +218,7 @@ to keep the restraint cost comparable to the residual of a single data point.
218218
``Restraint`` whose penalty is the root-mean-square deviation from the expected
219219
and calculated BVS of a structure.
220220

221-
.. literalinclude:: ../../../src/diffpy/srfit/structure/bvsrestraint.py
221+
.. literalinclude:: ../../src/diffpy/srfit/structure/bvsrestraint.py
222222
:pyobject: BVSRestraint
223223

224224
Note that the penalty scaling is optional (selected by the `scaled` flag) and
@@ -230,7 +230,7 @@ restrainable object. A ``BVSRestraint`` is used to restrain a ``SrRealParSet``,
230230
which is a ``ParameterSet`` wrapper base class for SrReal-compatible
231231
structures. The restraint is applied with the ``restrainBVS`` method.
232232

233-
.. literalinclude:: ../../../src/diffpy/srfit/structure/srrealparset.py
233+
.. literalinclude:: ../../src/diffpy/srfit/structure/srrealparset.py
234234
:pyobject: SrRealParSet.restrainBVS
235235

236236
The purpose of the method is to create the custom ``Restraint`` object,

docs/source/release.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
:tocdepth: -1
2+
13
.. index:: release notes
24

3-
.. mdinclude:: ../../../CHANGELOG.md
5+
.. include:: ../../CHANGELOG.rst

0 commit comments

Comments
 (0)