Skip to content

Commit 0e04f7a

Browse files
authored
chore: update README.rst with correct code block rendering and delete documentation link
Removed outdated documentation and improved code block rendering for installation instructions.
1 parent 8f54d38 commit 0e04f7a

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@
2525

2626
Configuration utilities for diffpy project. Part of xPDFsuite.
2727

28-
For more information about the diffpy.srxconfutils library, please consult our `online documentation <https://diffpy.github.io/diffpy.srxconfutils>`_.
29-
3028
Citation
3129
--------
3230

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

48-
Assuming you have a wheel file in the current working directory, in an active conda environment please type
46+
Assuming you have a wheel file in the current working directory, in an active conda environment please type ::
4947

5048
pip install ./diffpy.srxconfutils-VERSION.whl
5149

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

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

5755
conda create -n conf-env python=3.13
5856
conda activate conf-env
5957

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

6462
pip install ./diffpy.srxconfutils-VERSION.whl
6563

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

7169
conda activate conf-env
7270
conda install --file ./requirements/conda.txt

0 commit comments

Comments
 (0)