Skip to content

Commit 3a56590

Browse files
john-halloranJohn Halloran
andauthored
fix: correct issue with README indenting (#196)
Co-authored-by: John Halloran <jhalloran@oxy.edu>
1 parent 8c58412 commit 3a56590

2 files changed

Lines changed: 34 additions & 6 deletions

File tree

README.rst

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
:target: https://diffpy.github.io/diffpy.stretched-nmf
99
:height: 100px
1010

11+
.. _online documentation: https://diffpy.github.io/diffpy.stretched-nmf
12+
1113
|PyPI| |Forge| |PythonVersion| |PR|
1214

1315
|CI| |Codecov| |Black| |Tracking|
@@ -43,17 +45,20 @@ on the independent variable axis. For example, for powder diffraction data taken
4345
chemical phases where the measurements were done at different temperatures and the materials were undergoing thermal
4446
expansion.
4547

46-
For more information about the diffpy.stretched-nmf library, please consult our `online documentation <https://diffpy.github.io/diffpy.stretched-nmf>`_.
48+
For more information about the diffpy.stretched-nmf library, please consult our
49+
`online documentation`_.
4750

4851
Citation
4952
--------
5053

5154
If you use diffpy.stretched-nmf in a scientific publication, we would like you to cite this package as
5255

53-
Ran Gu, Yevgeny Rakita, Ling Lan, Zach Thatcher, Gabrielle E. Kamm, Daniel O’Nolan, Brennan Mcbride, Allison Wustrow, James R. Neilson, Karena W. Chapman, Qiang Du, and Simon J. L. Billinge,
54-
`Stretched Non-negative Matrix Factorization
55-
<https://doi.org/10.1038/s41524-024-01377-5>`__,
56-
*npj Comput Mater* **10**, 193 (2024).
56+
Ran Gu, Yevgeny Rakita, Ling Lan, Zach Thatcher, Gabrielle E. Kamm,
57+
Daniel O'Nolan, Brennan McBride, Allison Wustrow, James R. Neilson,
58+
Karena W. Chapman, Qiang Du, and Simon J. L. Billinge,
59+
`Stretched Non-negative Matrix Factorization
60+
<https://doi.org/10.1038/s41524-024-01377-5>`__,
61+
*npj Comput Mater* **10**, 193 (2024).
5762

5863
Installation
5964
------------
@@ -85,7 +90,7 @@ To view the basic usage and available commands, type ::
8590
Getting Started
8691
---------------
8792

88-
You may consult our `online documentation <https://diffpy.github.io/diffpy.stretched-nmf>`_ for tutorials and API references.
93+
You may consult our `online documentation`_ for tutorials and API references.
8994

9095
Support and Contribute
9196
----------------------

news/pypi-fix.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* <news item>
4+
5+
**Changed:**
6+
7+
* <news item>
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* <news item>
16+
17+
**Fixed:**
18+
19+
* Reformat README for PyPi compatibility
20+
21+
**Security:**
22+
23+
* <news item>

0 commit comments

Comments
 (0)