diff --git a/LICENSENOTICE.txt b/LICENSENOTICE.rst similarity index 100% rename from LICENSENOTICE.txt rename to LICENSENOTICE.rst diff --git a/README.rst b/README.rst index 90cf3c6..1b418c7 100644 --- a/README.rst +++ b/README.rst @@ -15,9 +15,6 @@ .. |Black| image:: https://img.shields.io/badge/code_style-black-black :target: https://github.com/psf/black -.. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff - :target: https://github.com/diffpy/diffpy.distanceprinter/pulls - .. |PythonVersion| image:: https://img.shields.io/badge/python-3.11%20|%203.12%20|%203.13-blue :target: https://pypi.org/project/diffpy.distanceprinter/ @@ -44,28 +41,28 @@ Independent Installation ------------------------ You can also install ``diffpy.distanceprinter`` 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.distanceprinter-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 "distanceprinter-env" is +The commands to create and activate the conda environment with name "distanceprinter-env" is :: conda create -n distanceprinter-env python=3.13 conda activate distanceprinter-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.distanceprinter-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 distanceprinter-env conda install --file ./requirements/conda.txt diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..e69de29 diff --git a/news/doc-fixes.rst b/news/doc-fixes.rst new file mode 100644 index 0000000..8711e5a --- /dev/null +++ b/news/doc-fixes.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* fixed documentation issues diff --git a/news/doc.rst b/news/skpkg.rst similarity index 100% rename from news/doc.rst rename to news/skpkg.rst