diff --git a/.flake8 b/.flake8 index 04d2d0b0..a5105116 100644 --- a/.flake8 +++ b/.flake8 @@ -6,7 +6,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/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/manual/Makefile b/docs/manual/Makefile similarity index 100% rename from doc/manual/Makefile rename to docs/manual/Makefile diff --git a/doc/manual/requirements.txt b/docs/manual/requirements.txt similarity index 100% rename from doc/manual/requirements.txt rename to docs/manual/requirements.txt 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.structure.apps.rst b/docs/source/api/diffpy.structure.apps.rst similarity index 100% rename from doc/source/api/diffpy.structure.apps.rst rename to docs/source/api/diffpy.structure.apps.rst diff --git a/doc/source/api/diffpy.structure.expansion.rst b/docs/source/api/diffpy.structure.expansion.rst similarity index 100% rename from doc/source/api/diffpy.structure.expansion.rst rename to docs/source/api/diffpy.structure.expansion.rst diff --git a/doc/source/api/diffpy.structure.parsers.rst b/docs/source/api/diffpy.structure.parsers.rst similarity index 100% rename from doc/source/api/diffpy.structure.parsers.rst rename to docs/source/api/diffpy.structure.parsers.rst diff --git a/doc/source/api/diffpy.structure.rst b/docs/source/api/diffpy.structure.rst similarity index 100% rename from doc/source/api/diffpy.structure.rst rename to docs/source/api/diffpy.structure.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 6e3d83bc..15ccfef6 100644 --- a/doc/source/conf.py +++ b/docs/source/conf.py @@ -139,7 +139,7 @@ "github_user": "diffpy", "github_repo": "diffpy.structure", "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 @@ -222,7 +222,7 @@ # Output file base name for HTML help builder. basename = "diffpy.structure".replace(" ", "").replace(".", "") -htmlhelp_basename = basename + "doc" +htmlhelp_basename = basename + "docs" # -- Options for LaTeX output --------------------------------------------- diff --git a/doc/source/diffpy.structure.apps.rst b/docs/source/diffpy.structure.apps.rst similarity index 100% rename from doc/source/diffpy.structure.apps.rst rename to docs/source/diffpy.structure.apps.rst diff --git a/doc/source/diffpy.structure.expansion.rst b/docs/source/diffpy.structure.expansion.rst similarity index 100% rename from doc/source/diffpy.structure.expansion.rst rename to docs/source/diffpy.structure.expansion.rst diff --git a/doc/source/diffpy.structure.parsers.rst b/docs/source/diffpy.structure.parsers.rst similarity index 100% rename from doc/source/diffpy.structure.parsers.rst rename to docs/source/diffpy.structure.parsers.rst diff --git a/doc/source/img/.placeholder b/docs/source/img/.placeholder similarity index 100% rename from doc/source/img/.placeholder rename to docs/source/img/.placeholder 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/mod-atom.rst b/docs/source/mod-atom.rst similarity index 100% rename from doc/source/mod-atom.rst rename to docs/source/mod-atom.rst diff --git a/doc/source/mod-lattice.rst b/docs/source/mod-lattice.rst similarity index 100% rename from doc/source/mod-lattice.rst rename to docs/source/mod-lattice.rst diff --git a/doc/source/mod-spacegroup.rst b/docs/source/mod-spacegroup.rst similarity index 100% rename from doc/source/mod-spacegroup.rst rename to docs/source/mod-spacegroup.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/doc/source/snippets/.placeholder b/docs/source/snippets/.placeholder similarity index 100% rename from doc/source/snippets/.placeholder rename to docs/source/snippets/.placeholder diff --git a/news/new-group-standard.rst b/news/new-group-standard.rst new file mode 100644 index 00000000..e1107145 --- /dev/null +++ b/news/new-group-standard.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* Use the names CODE-OF-CONDUCT.rst, docs and requirements/tests.txt according to the new group standard. + +**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