From 6f348a204cc8f8ac30abd9516d7ae07627e71446 Mon Sep 17 00:00:00 2001 From: John Halloran Date: Mon, 23 Mar 2026 02:55:30 -0400 Subject: [PATCH] fix: correct issue with README indenting --- README.rst | 17 +++++++++++------ news/pypi-fix.rst | 23 +++++++++++++++++++++++ 2 files changed, 34 insertions(+), 6 deletions(-) create mode 100644 news/pypi-fix.rst diff --git a/README.rst b/README.rst index 701e860..b87a7c1 100644 --- a/README.rst +++ b/README.rst @@ -8,6 +8,8 @@ :target: https://diffpy.github.io/diffpy.stretched-nmf :height: 100px +.. _online documentation: https://diffpy.github.io/diffpy.stretched-nmf + |PyPI| |Forge| |PythonVersion| |PR| |CI| |Codecov| |Black| |Tracking| @@ -43,17 +45,20 @@ on the independent variable axis. For example, for powder diffraction data taken chemical phases where the measurements were done at different temperatures and the materials were undergoing thermal expansion. -For more information about the diffpy.stretched-nmf library, please consult our `online documentation `_. +For more information about the diffpy.stretched-nmf library, please consult our +`online documentation`_. Citation -------- If you use diffpy.stretched-nmf in a scientific publication, we would like you to cite this package as - 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, - `Stretched Non-negative Matrix Factorization - `__, - *npj Comput Mater* **10**, 193 (2024). + 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, + `Stretched Non-negative Matrix Factorization + `__, + *npj Comput Mater* **10**, 193 (2024). Installation ------------ @@ -85,7 +90,7 @@ To view the basic usage and available commands, type :: Getting Started --------------- -You may consult our `online documentation `_ for tutorials and API references. +You may consult our `online documentation`_ for tutorials and API references. Support and Contribute ---------------------- diff --git a/news/pypi-fix.rst b/news/pypi-fix.rst new file mode 100644 index 0000000..4ca8f6f --- /dev/null +++ b/news/pypi-fix.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* Reformat README for PyPi compatibility + +**Security:** + +*