From 5fff12d887bafd0f286e680c37d3655a63100840 Mon Sep 17 00:00:00 2001 From: Dasun Abeykoon Date: Thu, 23 Oct 2025 22:34:27 -0500 Subject: [PATCH 1/6] doc: fix the render of installation commands in README.rst Signed-off-by: Dasun Abeykoon --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 90cf3c6..01a1df2 100644 --- a/README.rst +++ b/README.rst @@ -44,28 +44,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 From d0fc3e64c02c4fd80750fba9c1229c04c1d59e5e Mon Sep 17 00:00:00 2001 From: Dasun Abeykoon Date: Thu, 23 Oct 2025 22:38:33 -0500 Subject: [PATCH 2/6] doc: convert LICENSENOTICE.txt to LICENSENOTICE.rst Signed-off-by: Dasun Abeykoon --- LICENSENOTICE.txt => LICENSENOTICE.rst | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename LICENSENOTICE.txt => LICENSENOTICE.rst (100%) diff --git a/LICENSENOTICE.txt b/LICENSENOTICE.rst similarity index 100% rename from LICENSENOTICE.txt rename to LICENSENOTICE.rst From d046b07755d3c7a91a645080f62ed8ef94b4a5af Mon Sep 17 00:00:00 2001 From: Dasun Abeykoon Date: Thu, 23 Oct 2025 22:40:31 -0500 Subject: [PATCH 3/6] doc: update skpkg migration news Signed-off-by: Dasun Abeykoon --- news/{doc.rst => skpkg.rst} | 1 + 1 file changed, 1 insertion(+) rename news/{doc.rst => skpkg.rst} (90%) diff --git a/news/doc.rst b/news/skpkg.rst similarity index 90% rename from news/doc.rst rename to news/skpkg.rst index 35c29f4..be17067 100644 --- a/news/doc.rst +++ b/news/skpkg.rst @@ -6,6 +6,7 @@ * Updated from Python 2.6-2.7 to Python 3.11-3.13 * Support ``scikit-package`` Level 5 standard (https://scikit-package.github.io/scikit-package/). +* Rewrite README.rst instructions **Deprecated:** From e5df2a61de12f51d8ac524ea28fc37c00fddcba9 Mon Sep 17 00:00:00 2001 From: Dasun Abeykoon Date: Thu, 23 Oct 2025 22:49:29 -0500 Subject: [PATCH 4/6] doc: create index page Signed-off-by: Dasun Abeykoon --- docs/source/index.rst | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/source/index.rst diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..e69de29 From 94cd71afa1dc8a84d25a81782e0286e5881ffd1a Mon Sep 17 00:00:00 2001 From: Dasun Abeykoon Date: Fri, 24 Oct 2025 06:24:25 -0500 Subject: [PATCH 5/6] doc: modified news files to account for trival changes Signed-off-by: Dasun Abeykoon --- news/doc-fixes.rst | 23 +++++++++++++++++++++++ news/skpkg.rst | 1 - 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 news/doc-fixes.rst 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/skpkg.rst b/news/skpkg.rst index be17067..35c29f4 100644 --- a/news/skpkg.rst +++ b/news/skpkg.rst @@ -6,7 +6,6 @@ * Updated from Python 2.6-2.7 to Python 3.11-3.13 * Support ``scikit-package`` Level 5 standard (https://scikit-package.github.io/scikit-package/). -* Rewrite README.rst instructions **Deprecated:** From 122977896d674f4690774b2f028a7438c235164a Mon Sep 17 00:00:00 2001 From: Dasun Abeykoon Date: Fri, 24 Oct 2025 06:26:32 -0500 Subject: [PATCH 6/6] doc: remove 'prs welcome' badge from README.rst Signed-off-by: Dasun Abeykoon --- README.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.rst b/README.rst index 01a1df2..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/