diff --git a/.flake8 b/.flake8 index 04d2d0b0c..a51051160 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/.gitignore b/.gitignore index 949d3f213..d727eafb9 100644 --- a/.gitignore +++ b/.gitignore @@ -93,4 +93,4 @@ target/ .ipynb_checkpoints # Auto sphinx docs -doc/source/collections/ +docs/source/collections/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 47f7a0177..aaa888958 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 95% rename from doc/make.bat rename to docs/make.bat index ac53d5bd0..2be830693 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/Makefile b/docs/source/Makefile similarity index 100% rename from doc/source/Makefile rename to docs/source/Makefile 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/_static/cv.png b/docs/source/_static/cv.png similarity index 100% rename from doc/source/_static/cv.png rename to docs/source/_static/cv.png diff --git a/doc/source/_static/regolith-logo-white.png b/docs/source/_static/regolith-logo-white.png similarity index 100% rename from doc/source/_static/regolith-logo-white.png rename to docs/source/_static/regolith-logo-white.png diff --git a/doc/source/_static/regolith-logo-white.svg b/docs/source/_static/regolith-logo-white.svg similarity index 100% rename from doc/source/_static/regolith-logo-white.svg rename to docs/source/_static/regolith-logo-white.svg diff --git a/doc/source/_static/regolith-logo.ico b/docs/source/_static/regolith-logo.ico similarity index 100% rename from doc/source/_static/regolith-logo.ico rename to docs/source/_static/regolith-logo.ico diff --git a/doc/source/_static/regolith-logo.png b/docs/source/_static/regolith-logo.png similarity index 100% rename from doc/source/_static/regolith-logo.png rename to docs/source/_static/regolith-logo.png diff --git a/doc/source/_static/regolith-logo.svg b/docs/source/_static/regolith-logo.svg similarity index 100% rename from doc/source/_static/regolith-logo.svg rename to docs/source/_static/regolith-logo.svg diff --git a/doc/source/_static/rg-dungeon.js b/docs/source/_static/rg-dungeon.js similarity index 100% rename from doc/source/_static/rg-dungeon.js rename to docs/source/_static/rg-dungeon.js diff --git a/doc/source/_static/unicodetiles.css b/docs/source/_static/unicodetiles.css similarity index 100% rename from doc/source/_static/unicodetiles.css rename to docs/source/_static/unicodetiles.css diff --git a/doc/source/_static/unicodetiles.min.js b/docs/source/_static/unicodetiles.min.js similarity index 100% rename from doc/source/_static/unicodetiles.min.js rename to docs/source/_static/unicodetiles.min.js diff --git a/doc/source/_themes/blackcloud/static/blackcloud.css_t b/docs/source/_themes/blackcloud/static/blackcloud.css_t similarity index 100% rename from doc/source/_themes/blackcloud/static/blackcloud.css_t rename to docs/source/_themes/blackcloud/static/blackcloud.css_t diff --git a/doc/source/_themes/blackcloud/theme.conf b/docs/source/_themes/blackcloud/theme.conf similarity index 100% rename from doc/source/_themes/blackcloud/theme.conf rename to docs/source/_themes/blackcloud/theme.conf diff --git a/doc/source/api/regolith.builders.rst b/docs/source/api/regolith.builders.rst similarity index 100% rename from doc/source/api/regolith.builders.rst rename to docs/source/api/regolith.builders.rst diff --git a/doc/source/api/regolith.helpers.rst b/docs/source/api/regolith.helpers.rst similarity index 100% rename from doc/source/api/regolith.helpers.rst rename to docs/source/api/regolith.helpers.rst diff --git a/doc/source/api/regolith.rst b/docs/source/api/regolith.rst similarity index 100% rename from doc/source/api/regolith.rst rename to docs/source/api/regolith.rst diff --git a/doc/source/api/regolith.static.img.rst b/docs/source/api/regolith.static.img.rst similarity index 100% rename from doc/source/api/regolith.static.img.rst rename to docs/source/api/regolith.static.img.rst diff --git a/doc/source/api/regolith.static.rst b/docs/source/api/regolith.static.rst similarity index 100% rename from doc/source/api/regolith.static.rst rename to docs/source/api/regolith.static.rst diff --git a/doc/source/api/regolith.templates.rst b/docs/source/api/regolith.templates.rst similarity index 100% rename from doc/source/api/regolith.templates.rst rename to docs/source/api/regolith.templates.rst diff --git a/doc/source/collections/abstracts.rst b/docs/source/collections/abstracts.rst similarity index 100% rename from doc/source/collections/abstracts.rst rename to docs/source/collections/abstracts.rst diff --git a/doc/source/collections/assignments.rst b/docs/source/collections/assignments.rst similarity index 100% rename from doc/source/collections/assignments.rst rename to docs/source/collections/assignments.rst diff --git a/doc/source/collections/beamplan.rst b/docs/source/collections/beamplan.rst similarity index 100% rename from doc/source/collections/beamplan.rst rename to docs/source/collections/beamplan.rst diff --git a/doc/source/collections/blog.rst b/docs/source/collections/blog.rst similarity index 100% rename from doc/source/collections/blog.rst rename to docs/source/collections/blog.rst diff --git a/doc/source/collections/citations.rst b/docs/source/collections/citations.rst similarity index 100% rename from doc/source/collections/citations.rst rename to docs/source/collections/citations.rst diff --git a/doc/source/collections/contacts.rst b/docs/source/collections/contacts.rst similarity index 100% rename from doc/source/collections/contacts.rst rename to docs/source/collections/contacts.rst diff --git a/doc/source/collections/courses.rst b/docs/source/collections/courses.rst similarity index 100% rename from doc/source/collections/courses.rst rename to docs/source/collections/courses.rst diff --git a/doc/source/collections/expenses.rst b/docs/source/collections/expenses.rst similarity index 100% rename from doc/source/collections/expenses.rst rename to docs/source/collections/expenses.rst diff --git a/doc/source/collections/formalletters.rst b/docs/source/collections/formalletters.rst similarity index 100% rename from doc/source/collections/formalletters.rst rename to docs/source/collections/formalletters.rst diff --git a/doc/source/collections/grades.rst b/docs/source/collections/grades.rst similarity index 100% rename from doc/source/collections/grades.rst rename to docs/source/collections/grades.rst diff --git a/doc/source/collections/grants.rst b/docs/source/collections/grants.rst similarity index 100% rename from doc/source/collections/grants.rst rename to docs/source/collections/grants.rst diff --git a/doc/source/collections/groups.rst b/docs/source/collections/groups.rst similarity index 100% rename from doc/source/collections/groups.rst rename to docs/source/collections/groups.rst diff --git a/doc/source/collections/index.rst b/docs/source/collections/index.rst similarity index 100% rename from doc/source/collections/index.rst rename to docs/source/collections/index.rst diff --git a/doc/source/collections/institutions.rst b/docs/source/collections/institutions.rst similarity index 100% rename from doc/source/collections/institutions.rst rename to docs/source/collections/institutions.rst diff --git a/doc/source/collections/jobs.rst b/docs/source/collections/jobs.rst similarity index 100% rename from doc/source/collections/jobs.rst rename to docs/source/collections/jobs.rst diff --git a/doc/source/collections/meetings.rst b/docs/source/collections/meetings.rst similarity index 100% rename from doc/source/collections/meetings.rst rename to docs/source/collections/meetings.rst diff --git a/doc/source/collections/news.rst b/docs/source/collections/news.rst similarity index 100% rename from doc/source/collections/news.rst rename to docs/source/collections/news.rst diff --git a/doc/source/collections/people.rst b/docs/source/collections/people.rst similarity index 100% rename from doc/source/collections/people.rst rename to docs/source/collections/people.rst diff --git a/doc/source/collections/presentations.rst b/docs/source/collections/presentations.rst similarity index 100% rename from doc/source/collections/presentations.rst rename to docs/source/collections/presentations.rst diff --git a/doc/source/collections/projecta.rst b/docs/source/collections/projecta.rst similarity index 100% rename from doc/source/collections/projecta.rst rename to docs/source/collections/projecta.rst diff --git a/doc/source/collections/projects.rst b/docs/source/collections/projects.rst similarity index 100% rename from doc/source/collections/projects.rst rename to docs/source/collections/projects.rst diff --git a/doc/source/collections/proposalReviews.rst b/docs/source/collections/proposalReviews.rst similarity index 100% rename from doc/source/collections/proposalReviews.rst rename to docs/source/collections/proposalReviews.rst diff --git a/doc/source/collections/proposals.rst b/docs/source/collections/proposals.rst similarity index 100% rename from doc/source/collections/proposals.rst rename to docs/source/collections/proposals.rst diff --git a/doc/source/collections/reading_lists.rst b/docs/source/collections/reading_lists.rst similarity index 100% rename from doc/source/collections/reading_lists.rst rename to docs/source/collections/reading_lists.rst diff --git a/doc/source/collections/refereeReports.rst b/docs/source/collections/refereeReports.rst similarity index 100% rename from doc/source/collections/refereeReports.rst rename to docs/source/collections/refereeReports.rst diff --git a/doc/source/collections/software.rst b/docs/source/collections/software.rst similarity index 100% rename from doc/source/collections/software.rst rename to docs/source/collections/software.rst diff --git a/doc/source/collections/students.rst b/docs/source/collections/students.rst similarity index 100% rename from doc/source/collections/students.rst rename to docs/source/collections/students.rst diff --git a/doc/source/collections/todos.rst b/docs/source/collections/todos.rst similarity index 100% rename from doc/source/collections/todos.rst rename to docs/source/collections/todos.rst diff --git a/doc/source/commands/add.rst b/docs/source/commands/add.rst similarity index 100% rename from doc/source/commands/add.rst rename to docs/source/commands/add.rst diff --git a/doc/source/commands/app.rst b/docs/source/commands/app.rst similarity index 100% rename from doc/source/commands/app.rst rename to docs/source/commands/app.rst diff --git a/doc/source/commands/build.rst b/docs/source/commands/build.rst similarity index 100% rename from doc/source/commands/build.rst rename to docs/source/commands/build.rst diff --git a/doc/source/commands/classlist.rst b/docs/source/commands/classlist.rst similarity index 100% rename from doc/source/commands/classlist.rst rename to docs/source/commands/classlist.rst diff --git a/doc/source/commands/deploy.rst b/docs/source/commands/deploy.rst similarity index 100% rename from doc/source/commands/deploy.rst rename to docs/source/commands/deploy.rst diff --git a/doc/source/commands/email.rst b/docs/source/commands/email.rst similarity index 100% rename from doc/source/commands/email.rst rename to docs/source/commands/email.rst diff --git a/doc/source/commands/fs-to-mongo.rst b/docs/source/commands/fs-to-mongo.rst similarity index 100% rename from doc/source/commands/fs-to-mongo.rst rename to docs/source/commands/fs-to-mongo.rst diff --git a/doc/source/commands/grade.rst b/docs/source/commands/grade.rst similarity index 100% rename from doc/source/commands/grade.rst rename to docs/source/commands/grade.rst diff --git a/doc/source/commands/helper.rst b/docs/source/commands/helper.rst similarity index 100% rename from doc/source/commands/helper.rst rename to docs/source/commands/helper.rst diff --git a/doc/source/commands/index.html b/docs/source/commands/index.html similarity index 99% rename from doc/source/commands/index.html rename to docs/source/commands/index.html index cba2d130c..e69b437a7 100644 --- a/doc/source/commands/index.html +++ b/docs/source/commands/index.html @@ -394,7 +394,7 @@