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 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 ------- 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 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:** + +*