From d6541e9dd816875a78bb8e1a7642b06a0b22a90c Mon Sep 17 00:00:00 2001 From: Yuchen Ethan Xiao Date: Wed, 30 Jul 2025 12:03:49 -0400 Subject: [PATCH] style: use `CODE-OF-CONDUCT.rst`, `tests.txt` and `docs` according to the new group standards --- .flake8 | 2 +- .github/ISSUE_TEMPLATE/release_checklist.md | 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.pdffit2.rst | 0 {doc => docs}/source/conf.py | 2 +- {doc => docs}/source/examples.rst | 0 {doc => docs}/source/examples/Ni-xray.gr | 0 {doc => docs}/source/examples/Ni.stru | 0 .../source/examples/Ni_calculation.py | 0 .../source/examples/Ni_refinement.py | 0 {doc => docs}/source/index.rst | 0 {doc => docs}/source/license.rst | 0 {doc => docs}/source/release.rst | 0 news/naming-standard.rst | 23 +++++++++++++++++++ requirements/{test.txt => tests.txt} | 0 20 files changed, 28 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.pdffit2.rst (100%) rename {doc => docs}/source/conf.py (99%) rename {doc => docs}/source/examples.rst (100%) rename {doc => docs}/source/examples/Ni-xray.gr (100%) rename {doc => docs}/source/examples/Ni.stru (100%) rename {doc => docs}/source/examples/Ni_calculation.py (100%) rename {doc => docs}/source/examples/Ni_refinement.py (100%) rename {doc => docs}/source/index.rst (100%) rename {doc => docs}/source/license.rst (100%) rename {doc => docs}/source/release.rst (100%) create mode 100644 news/naming-standard.rst rename requirements/{test.txt => tests.txt} (100%) diff --git a/.flake8 b/.flake8 index 2d2cb168..379715f7 100644 --- a/.flake8 +++ b/.flake8 @@ -4,7 +4,7 @@ exclude = __pycache__, build, dist, - doc/source/conf.py + docs/source/conf.py max-line-length = 115 # 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/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 6107962c..56bcd015 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -34,7 +34,7 @@ Please let the maintainer know that all checks are done and the package is ready - [ ] Ensure that the full release has appeared on PyPI successfully. -- [ ] New package dependencies listed in `conda.txt` and `test.txt` are added to `meta.yaml` in the feedstock. +- [ ] New package dependencies listed in `conda.txt` and `tests.txt` are added to `meta.yaml` in the feedstock. - [ ] Close any open issues on the feedstock. Reach out to the maintainer if you have questions. - [ ] Tag the maintainer for conda-forge release. 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 4c90e849..4c167809 100644 --- a/README.rst +++ b/README.rst @@ -170,7 +170,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.pdffit2.rst b/docs/source/api/diffpy.pdffit2.rst similarity index 100% rename from doc/source/api/diffpy.pdffit2.rst rename to docs/source/api/diffpy.pdffit2.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 58fb11f6..5ca9cb83 100644 --- a/doc/source/conf.py +++ b/docs/source/conf.py @@ -144,7 +144,7 @@ "github_user": "diffpy", "github_repo": "diffpy.pdffit2", "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/Ni-xray.gr b/docs/source/examples/Ni-xray.gr similarity index 100% rename from doc/source/examples/Ni-xray.gr rename to docs/source/examples/Ni-xray.gr diff --git a/doc/source/examples/Ni.stru b/docs/source/examples/Ni.stru similarity index 100% rename from doc/source/examples/Ni.stru rename to docs/source/examples/Ni.stru diff --git a/doc/source/examples/Ni_calculation.py b/docs/source/examples/Ni_calculation.py similarity index 100% rename from doc/source/examples/Ni_calculation.py rename to docs/source/examples/Ni_calculation.py diff --git a/doc/source/examples/Ni_refinement.py b/docs/source/examples/Ni_refinement.py similarity index 100% rename from doc/source/examples/Ni_refinement.py rename to docs/source/examples/Ni_refinement.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/news/naming-standard.rst b/news/naming-standard.rst new file mode 100644 index 00000000..9f52c990 --- /dev/null +++ b/news/naming-standard.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* Use CODE-OF-CONDUCT.rst, tests.txt and docs according to the new group standards + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* diff --git a/requirements/test.txt b/requirements/tests.txt similarity index 100% rename from requirements/test.txt rename to requirements/tests.txt