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/.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 5fb8421e..cf989cdf 100644 --- a/README.rst +++ b/README.rst @@ -136,7 +136,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.utils.parsers.rst b/docs/source/api/diffpy.utils.parsers.rst similarity index 100% rename from doc/source/api/diffpy.utils.parsers.rst rename to docs/source/api/diffpy.utils.parsers.rst diff --git a/doc/source/api/diffpy.utils.rst b/docs/source/api/diffpy.utils.rst similarity index 100% rename from doc/source/api/diffpy.utils.rst rename to docs/source/api/diffpy.utils.rst diff --git a/doc/source/api/diffpy.utils.wx.rst b/docs/source/api/diffpy.utils.wx.rst similarity index 100% rename from doc/source/api/diffpy.utils.wx.rst rename to docs/source/api/diffpy.utils.wx.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 ae2443a1..6a8add42 100644 --- a/doc/source/conf.py +++ b/docs/source/conf.py @@ -140,7 +140,7 @@ "github_user": "diffpy", "github_repo": "diffpy.utils", "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 @@ -223,7 +223,7 @@ # Output file base name for HTML help builder. basename = "diffpy.utils".replace(" ", "").replace(".", "") -htmlhelp_basename = basename + "doc" +htmlhelp_basename = basename + "docs" # -- Options for LaTeX output --------------------------------------------- diff --git a/doc/source/examples/diffraction_objects_example.rst b/docs/source/examples/diffraction_objects_example.rst similarity index 100% rename from doc/source/examples/diffraction_objects_example.rst rename to docs/source/examples/diffraction_objects_example.rst diff --git a/doc/source/examples/example_data/parser_data.zip b/docs/source/examples/example_data/parser_data.zip similarity index 100% rename from doc/source/examples/example_data/parser_data.zip rename to docs/source/examples/example_data/parser_data.zip diff --git a/doc/source/examples/examples.rst b/docs/source/examples/examples.rst similarity index 100% rename from doc/source/examples/examples.rst rename to docs/source/examples/examples.rst diff --git a/doc/source/examples/parsers_example.rst b/docs/source/examples/parsers_example.rst similarity index 100% rename from doc/source/examples/parsers_example.rst rename to docs/source/examples/parsers_example.rst diff --git a/doc/source/examples/resample_example.rst b/docs/source/examples/resample_example.rst similarity index 100% rename from doc/source/examples/resample_example.rst rename to docs/source/examples/resample_example.rst diff --git a/doc/source/examples/tools_example.rst b/docs/source/examples/tools_example.rst similarity index 100% rename from doc/source/examples/tools_example.rst rename to docs/source/examples/tools_example.rst diff --git a/doc/source/examples/transforms_example.rst b/docs/source/examples/transforms_example.rst similarity index 100% rename from doc/source/examples/transforms_example.rst rename to docs/source/examples/transforms_example.rst 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/doc/source/utilities/diffraction_objects_utility.rst b/docs/source/utilities/diffraction_objects_utility.rst similarity index 100% rename from doc/source/utilities/diffraction_objects_utility.rst rename to docs/source/utilities/diffraction_objects_utility.rst diff --git a/doc/source/utilities/parsers_utility.rst b/docs/source/utilities/parsers_utility.rst similarity index 100% rename from doc/source/utilities/parsers_utility.rst rename to docs/source/utilities/parsers_utility.rst diff --git a/doc/source/utilities/resample_utility.rst b/docs/source/utilities/resample_utility.rst similarity index 100% rename from doc/source/utilities/resample_utility.rst rename to docs/source/utilities/resample_utility.rst diff --git a/doc/source/utilities/tools_utility.rst b/docs/source/utilities/tools_utility.rst similarity index 100% rename from doc/source/utilities/tools_utility.rst rename to docs/source/utilities/tools_utility.rst diff --git a/doc/source/utilities/transforms_utility.rst b/docs/source/utilities/transforms_utility.rst similarity index 100% rename from doc/source/utilities/transforms_utility.rst rename to docs/source/utilities/transforms_utility.rst diff --git a/doc/source/utilities/utilities.rst b/docs/source/utilities/utilities.rst similarity index 100% rename from doc/source/utilities/utilities.rst rename to docs/source/utilities/utilities.rst diff --git a/news/group-standard.rst b/news/group-standard.rst new file mode 100644 index 00000000..69ba1d29 --- /dev/null +++ b/news/group-standard.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news added: Use ``CODE-OF-CONDUCT,rst``, ``requirements/tests.text`` and ``docs`` according to new group standard. + +**Changed:** + +* + +**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