From e43aab6f05cbc9a24de7deb3ff2d024919770a96 Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Wed, 24 Dec 2025 10:55:03 -0600 Subject: [PATCH 1/4] change doc to docs --- {doc => docs}/Makefile | 0 {doc => docs}/make.bat | 72 +++++++++---------- {doc => docs}/source/_static/.placeholder | 0 .../source/api/diffpy.labpdfproc.data.rst | 0 .../source/api/diffpy.labpdfproc.rst | 0 {doc => docs}/source/conf.py | 2 +- .../source/examples/example-data/zro2_mo.xy | 0 {doc => docs}/source/examples/examples.rst | 0 .../source/examples/functions-example.rst | 0 .../source/examples/labpdfprocapp-example.rst | 0 .../source/examples/tools-example.rst | 0 {doc => docs}/source/index.rst | 0 {doc => docs}/source/license.rst | 0 {doc => docs}/source/release.rst | 0 .../source/utilities/functions-utility.rst | 0 .../utilities/labpdfprocapp-utility.rst | 0 .../source/utilities/tools-utility.rst | 0 {doc => docs}/source/utilities/utilities.rst | 0 18 files changed, 37 insertions(+), 37 deletions(-) rename {doc => docs}/Makefile (100%) rename {doc => docs}/make.bat (95%) rename {doc => docs}/source/_static/.placeholder (100%) rename {doc => docs}/source/api/diffpy.labpdfproc.data.rst (100%) rename {doc => docs}/source/api/diffpy.labpdfproc.rst (100%) rename {doc => docs}/source/conf.py (99%) rename {doc => docs}/source/examples/example-data/zro2_mo.xy (100%) rename {doc => docs}/source/examples/examples.rst (100%) rename {doc => docs}/source/examples/functions-example.rst (100%) rename {doc => docs}/source/examples/labpdfprocapp-example.rst (100%) rename {doc => docs}/source/examples/tools-example.rst (100%) rename {doc => docs}/source/index.rst (100%) rename {doc => docs}/source/license.rst (100%) rename {doc => docs}/source/release.rst (100%) rename {doc => docs}/source/utilities/functions-utility.rst (100%) rename {doc => docs}/source/utilities/labpdfprocapp-utility.rst (100%) rename {doc => docs}/source/utilities/tools-utility.rst (100%) rename {doc => docs}/source/utilities/utilities.rst (100%) 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 95% rename from doc/make.bat rename to docs/make.bat index ac53d5b..2be8306 100644 --- a/doc/make.bat +++ b/docs/make.bat @@ -1,36 +1,36 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build -set SPHINXPROJ=PackagingScientificPython - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% - -:end -popd +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build +set SPHINXPROJ=PackagingScientificPython + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd 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.labpdfproc.data.rst b/docs/source/api/diffpy.labpdfproc.data.rst similarity index 100% rename from doc/source/api/diffpy.labpdfproc.data.rst rename to docs/source/api/diffpy.labpdfproc.data.rst diff --git a/doc/source/api/diffpy.labpdfproc.rst b/docs/source/api/diffpy.labpdfproc.rst similarity index 100% rename from doc/source/api/diffpy.labpdfproc.rst rename to docs/source/api/diffpy.labpdfproc.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 12c7366..2e73623 100644 --- a/doc/source/conf.py +++ b/docs/source/conf.py @@ -20,7 +20,7 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the -# documentation root, use Path().resolve() to make it absolute, like shown here. +# documentation root, use Path().resolve() to make it absolute, like shown here # sys.path.insert(0, str(Path(".").resolve())) sys.path.insert(0, str(Path("../..").resolve())) sys.path.insert(0, str(Path("../../src").resolve())) diff --git a/doc/source/examples/example-data/zro2_mo.xy b/docs/source/examples/example-data/zro2_mo.xy similarity index 100% rename from doc/source/examples/example-data/zro2_mo.xy rename to docs/source/examples/example-data/zro2_mo.xy 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/functions-example.rst b/docs/source/examples/functions-example.rst similarity index 100% rename from doc/source/examples/functions-example.rst rename to docs/source/examples/functions-example.rst diff --git a/doc/source/examples/labpdfprocapp-example.rst b/docs/source/examples/labpdfprocapp-example.rst similarity index 100% rename from doc/source/examples/labpdfprocapp-example.rst rename to docs/source/examples/labpdfprocapp-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/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/functions-utility.rst b/docs/source/utilities/functions-utility.rst similarity index 100% rename from doc/source/utilities/functions-utility.rst rename to docs/source/utilities/functions-utility.rst diff --git a/doc/source/utilities/labpdfprocapp-utility.rst b/docs/source/utilities/labpdfprocapp-utility.rst similarity index 100% rename from doc/source/utilities/labpdfprocapp-utility.rst rename to docs/source/utilities/labpdfprocapp-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/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 From 3c39c96d1bf06d00650456e6d3ca7e5c0fd7347c Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Wed, 24 Dec 2025 11:02:02 -0600 Subject: [PATCH 2/4] change code of conduct --- CODE_OF_CONDUCT.rst => CODE-OF-CONDUCT.rst | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CODE_OF_CONDUCT.rst => CODE-OF-CONDUCT.rst (100%) 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 From 50107ebe1a08423d58dcdc0e8e39ab405c78b5af Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Wed, 24 Dec 2025 11:02:41 -0600 Subject: [PATCH 3/4] COC in read me --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 358c54d..1b8908c 100644 --- a/README.rst +++ b/README.rst @@ -156,7 +156,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 ------- From 1b1fcd1453e60e45bd082e0b0fe84dbbe8db43e3 Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Wed, 24 Dec 2025 11:04:54 -0600 Subject: [PATCH 4/4] news --- news/doc-change.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 news/doc-change.rst diff --git a/news/doc-change.rst b/news/doc-change.rst new file mode 100644 index 0000000..596d126 --- /dev/null +++ b/news/doc-change.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* Changed ``doc`` to ``docs`` and ``CODE_OF_CONDUCT.rst`` to ``CODE-OF-CONDUCT.rst`` to comply with scikit-package standards. + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*