Skip to content

chore: update README.rst with correct code block rendering and delete documentation link #20

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
merged 2 commits into from
Oct 20, 2025
Merged

chore: update README.rst with correct code block rendering and delete documentation link #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e04f7a
chore: update README.rst with correct code block rendering and delete…
zmx27 Oct 20, 2025
5776e2d
chore: add news file
zmx27 Oct 20, 2025
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
10 changes: 4 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@

Configuration utilities for diffpy project. Part of xPDFsuite.

For more information about the diffpy.srxconfutils library, please consult our `online documentation <https://diffpy.github.io/diffpy.srxconfutils>`_.

Citation
--------

Expand All @@ -45,28 +43,28 @@ Independent Installation
------------------------
You can also install ``diffpy.srxconfutils`` independently for yourself.

Assuming you have a wheel file in the current working directory, in an active conda environment please type
Assuming you have a wheel file in the current working directory, in an active conda environment please type ::

pip install ./diffpy.srxconfutils-VERSION.whl

where you replace VERSION with the actual version you have so the command matches the filename of the
wheel file you have.

The commands to create and activate the conda environment with name "conf-env" is
The commands to create and activate the conda environment with name "conf-env" is ::

conda create -n conf-env python=3.13
conda activate conf-env

If you don't have conda installed, we recomment you install `miniconda
<https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
To install this software from a Python wheel distribution format execute
To install this software from a Python wheel distribution format execute ::

pip install ./diffpy.srxconfutils-VERSION.whl

If you are a developer, you can also install this package from sources. First, obtain the source archive
from `GitHub <https://github.com/diffpy/diffpy.srxconfutils/>`_.
Install the packages in ``./requirements/conda.txt`` and ``./requirements/tests.txt``
using the `--file`` command:
using the ``--file`` command ::

conda activate conf-env
conda install --file ./requirements/conda.txt
Expand Down
23 changes: 23 additions & 0 deletions news/update-readme-rendering.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* No news added: Trivial changes to readme file

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
Loading