From 23a33e58987698eec22eece10d6b0df4710df39e Mon Sep 17 00:00:00 2001 From: Zhi Ming Xu Date: Tue, 29 Jul 2025 04:49:34 -0400 Subject: [PATCH 1/2] style: rename files/folders to comply with new group standards and update files to reflect this change --- .flake8 | 2 +- .github/workflows/tests-on-pr.yml | 2 +- .readthedocs.yaml | 2 +- CODE_OF_CONDUCT.rst => CODE-OF-CONDUCT.rst | 0 README.rst | 2 +- {doc => docs}/Makefile | 0 {doc => docs}/make.bat | 0 {doc => docs}/source/_static/.placeholder | 0 {doc => docs}/source/api/diffpy.srreal.example_package.rst | 0 {doc => docs}/source/api/diffpy.srreal.rst | 0 {doc => docs}/source/conf.py | 2 +- {doc => docs}/source/examples.rst | 0 {doc => docs}/source/examples/compareC60PDFs.py | 0 {doc => docs}/source/examples/compareC60PDFs_objcryst.py | 0 {doc => docs}/source/examples/datafiles/C60bucky.stru | 0 {doc => docs}/source/examples/datafiles/menthol.cif | 0 {doc => docs}/source/examples/datafiles/sphalerite.cif | 0 {doc => docs}/source/examples/distanceprinter.py | 0 {doc => docs}/source/examples/lennardjones/Makefile | 0 {doc => docs}/source/examples/lennardjones/README.txt | 0 {doc => docs}/source/examples/lennardjones/lj50.xyz | 0 {doc => docs}/source/examples/lennardjones/ljcalculator.cpp | 0 {doc => docs}/source/examples/lennardjones/ljcalculator.py | 0 {doc => docs}/source/examples/parallelPDF.py | 0 {doc => docs}/source/index.rst | 0 {doc => docs}/source/license.rst | 0 {doc => docs}/source/release.rst | 0 requirements/{test.txt => tests.txt} | 0 28 files changed, 5 insertions(+), 5 deletions(-) rename CODE_OF_CONDUCT.rst => CODE-OF-CONDUCT.rst (100%) rename {doc => docs}/Makefile (100%) rename {doc => docs}/make.bat (100%) rename {doc => docs}/source/_static/.placeholder (100%) rename {doc => docs}/source/api/diffpy.srreal.example_package.rst (100%) rename {doc => docs}/source/api/diffpy.srreal.rst (100%) rename {doc => docs}/source/conf.py (99%) rename {doc => docs}/source/examples.rst (100%) rename {doc => docs}/source/examples/compareC60PDFs.py (100%) rename {doc => docs}/source/examples/compareC60PDFs_objcryst.py (100%) rename {doc => docs}/source/examples/datafiles/C60bucky.stru (100%) rename {doc => docs}/source/examples/datafiles/menthol.cif (100%) rename {doc => docs}/source/examples/datafiles/sphalerite.cif (100%) rename {doc => docs}/source/examples/distanceprinter.py (100%) rename {doc => docs}/source/examples/lennardjones/Makefile (100%) rename {doc => docs}/source/examples/lennardjones/README.txt (100%) rename {doc => docs}/source/examples/lennardjones/lj50.xyz (100%) rename {doc => docs}/source/examples/lennardjones/ljcalculator.cpp (100%) rename {doc => docs}/source/examples/lennardjones/ljcalculator.py (100%) rename {doc => docs}/source/examples/parallelPDF.py (100%) rename {doc => docs}/source/index.rst (100%) rename {doc => docs}/source/license.rst (100%) rename {doc => docs}/source/release.rst (100%) rename requirements/{test.txt => tests.txt} (100%) diff --git a/.flake8 b/.flake8 index 7b2865c1..88077af0 100644 --- a/.flake8 +++ b/.flake8 @@ -6,7 +6,7 @@ exclude = __pycache__, build, dist, - doc/source/conf.py + docs/source/conf.py max-line-length = 79 # Ignore some style 'errors' produced while formatting by 'black' # https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#labels-why-pycodestyle-warnings diff --git a/.github/workflows/tests-on-pr.yml b/.github/workflows/tests-on-pr.yml index e5546783..43aa1665 100644 --- a/.github/workflows/tests-on-pr.yml +++ b/.github/workflows/tests-on-pr.yml @@ -42,7 +42,7 @@ jobs: conda install pip -y conda config --set always_yes yes --set changeps1 no conda install --file requirements/conda.txt -y - conda install --file requirements/test.txt -y + conda install --file requirements/tests.txt -y python -m pip install . --no-deps - name: Validate diffpy.pdfgui diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 47f7a017..aaa88895 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -10,4 +10,4 @@ python: - requirements: requirements/docs.txt sphinx: - configuration: doc/source/conf.py + configuration: docs/source/conf.py diff --git a/CODE_OF_CONDUCT.rst b/CODE-OF-CONDUCT.rst similarity index 100% rename from CODE_OF_CONDUCT.rst rename to CODE-OF-CONDUCT.rst diff --git a/README.rst b/README.rst index 502f3233..fa6bab07 100644 --- a/README.rst +++ b/README.rst @@ -144,7 +144,7 @@ trying to commit again. Improvements and fixes are always appreciated. -Before contributing, please read our `Code of Conduct `_. +Before contributing, please read our `Code of Conduct `_. Contact ------- diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/make.bat b/docs/make.bat similarity index 100% rename from doc/make.bat rename to docs/make.bat diff --git a/doc/source/_static/.placeholder b/docs/source/_static/.placeholder similarity index 100% rename from doc/source/_static/.placeholder rename to docs/source/_static/.placeholder diff --git a/doc/source/api/diffpy.srreal.example_package.rst b/docs/source/api/diffpy.srreal.example_package.rst similarity index 100% rename from doc/source/api/diffpy.srreal.example_package.rst rename to docs/source/api/diffpy.srreal.example_package.rst diff --git a/doc/source/api/diffpy.srreal.rst b/docs/source/api/diffpy.srreal.rst similarity index 100% rename from doc/source/api/diffpy.srreal.rst rename to docs/source/api/diffpy.srreal.rst diff --git a/doc/source/conf.py b/docs/source/conf.py similarity index 99% rename from doc/source/conf.py rename to docs/source/conf.py index a05707e1..6ac5e09e 100644 --- a/doc/source/conf.py +++ b/docs/source/conf.py @@ -139,7 +139,7 @@ "github_user": "diffpy", "github_repo": "diffpy.srreal", "github_version": "main", - "conf_py_path": "/doc/source/", + "conf_py_path": "/docs/source/", } # Theme options are theme-specific and customize the look and feel of a theme diff --git a/doc/source/examples.rst b/docs/source/examples.rst similarity index 100% rename from doc/source/examples.rst rename to docs/source/examples.rst diff --git a/doc/source/examples/compareC60PDFs.py b/docs/source/examples/compareC60PDFs.py similarity index 100% rename from doc/source/examples/compareC60PDFs.py rename to docs/source/examples/compareC60PDFs.py diff --git a/doc/source/examples/compareC60PDFs_objcryst.py b/docs/source/examples/compareC60PDFs_objcryst.py similarity index 100% rename from doc/source/examples/compareC60PDFs_objcryst.py rename to docs/source/examples/compareC60PDFs_objcryst.py diff --git a/doc/source/examples/datafiles/C60bucky.stru b/docs/source/examples/datafiles/C60bucky.stru similarity index 100% rename from doc/source/examples/datafiles/C60bucky.stru rename to docs/source/examples/datafiles/C60bucky.stru diff --git a/doc/source/examples/datafiles/menthol.cif b/docs/source/examples/datafiles/menthol.cif similarity index 100% rename from doc/source/examples/datafiles/menthol.cif rename to docs/source/examples/datafiles/menthol.cif diff --git a/doc/source/examples/datafiles/sphalerite.cif b/docs/source/examples/datafiles/sphalerite.cif similarity index 100% rename from doc/source/examples/datafiles/sphalerite.cif rename to docs/source/examples/datafiles/sphalerite.cif diff --git a/doc/source/examples/distanceprinter.py b/docs/source/examples/distanceprinter.py similarity index 100% rename from doc/source/examples/distanceprinter.py rename to docs/source/examples/distanceprinter.py diff --git a/doc/source/examples/lennardjones/Makefile b/docs/source/examples/lennardjones/Makefile similarity index 100% rename from doc/source/examples/lennardjones/Makefile rename to docs/source/examples/lennardjones/Makefile diff --git a/doc/source/examples/lennardjones/README.txt b/docs/source/examples/lennardjones/README.txt similarity index 100% rename from doc/source/examples/lennardjones/README.txt rename to docs/source/examples/lennardjones/README.txt diff --git a/doc/source/examples/lennardjones/lj50.xyz b/docs/source/examples/lennardjones/lj50.xyz similarity index 100% rename from doc/source/examples/lennardjones/lj50.xyz rename to docs/source/examples/lennardjones/lj50.xyz diff --git a/doc/source/examples/lennardjones/ljcalculator.cpp b/docs/source/examples/lennardjones/ljcalculator.cpp similarity index 100% rename from doc/source/examples/lennardjones/ljcalculator.cpp rename to docs/source/examples/lennardjones/ljcalculator.cpp diff --git a/doc/source/examples/lennardjones/ljcalculator.py b/docs/source/examples/lennardjones/ljcalculator.py similarity index 100% rename from doc/source/examples/lennardjones/ljcalculator.py rename to docs/source/examples/lennardjones/ljcalculator.py diff --git a/doc/source/examples/parallelPDF.py b/docs/source/examples/parallelPDF.py similarity index 100% rename from doc/source/examples/parallelPDF.py rename to docs/source/examples/parallelPDF.py diff --git a/doc/source/index.rst b/docs/source/index.rst similarity index 100% rename from doc/source/index.rst rename to docs/source/index.rst diff --git a/doc/source/license.rst b/docs/source/license.rst similarity index 100% rename from doc/source/license.rst rename to docs/source/license.rst diff --git a/doc/source/release.rst b/docs/source/release.rst similarity index 100% rename from doc/source/release.rst rename to docs/source/release.rst diff --git a/requirements/test.txt b/requirements/tests.txt similarity index 100% rename from requirements/test.txt rename to requirements/tests.txt From b3399b78a7d33518fa4127b1f00e78a7a92f74ea Mon Sep 17 00:00:00 2001 From: Zhi Ming Xu Date: Tue, 29 Jul 2025 04:51:38 -0400 Subject: [PATCH 2/2] chore: add news file --- news/update-names.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 news/update-names.rst diff --git a/news/update-names.rst b/news/update-names.rst new file mode 100644 index 00000000..d923a199 --- /dev/null +++ b/news/update-names.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* Renamed CODE_OF_CONDUCTS.rst to CODE-OF-CONDUCTS.rst, doc folder to docs, and requirements/test.txt to requirements/tests.txt + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*