From 0e04f7a111a1d0046118e3c9355de44c34912ad8 Mon Sep 17 00:00:00 2001 From: Zhi Ming Xu <95781012+zmx27@users.noreply.github.com> Date: Sun, 19 Oct 2025 20:23:15 -0400 Subject: [PATCH 1/2] chore: update README.rst with correct code block rendering and delete documentation link Removed outdated documentation and improved code block rendering for installation instructions. --- README.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 8a852ff..794e1d0 100644 --- a/README.rst +++ b/README.rst @@ -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 `_. - Citation -------- @@ -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 `_ -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 `_. 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 From 5776e2ddd1505b5a97b89e4141d818c822a506e2 Mon Sep 17 00:00:00 2001 From: Zhi Ming Xu Date: Sun, 19 Oct 2025 20:27:23 -0400 Subject: [PATCH 2/2] chore: add news file --- news/update-readme-rendering.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 news/update-readme-rendering.rst diff --git a/news/update-readme-rendering.rst b/news/update-readme-rendering.rst new file mode 100644 index 0000000..7b39780 --- /dev/null +++ b/news/update-readme-rendering.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news added: Trivial changes to readme file + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*