Skip to content

fix: correct issue with README indenting #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sbillinge merged 1 commit into from
Mar 24, 2026
+34 −6
Merged

fix: correct issue with README indenting #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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|
Expand Down Expand Up @@ -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 <https://diffpy.github.io/diffpy.stretched-nmf>`_.
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
<https://doi.org/10.1038/s41524-024-01377-5>`__,
*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
<https://doi.org/10.1038/s41524-024-01377-5>`__,
*npj Comput Mater* **10**, 193 (2024).

Installation
------------
Expand Down Expand Up @@ -85,7 +90,7 @@ To view the basic usage and available commands, type ::
Getting Started
---------------

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

Support and Contribute
----------------------
Expand Down
23 changes: 23 additions & 0 deletions news/pypi-fix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* <news item>

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* Reformat README for PyPi compatibility

**Security:**

* <news item>
Loading