diff --git a/documentation/Makefile b/docs/Makefile similarity index 100% rename from documentation/Makefile rename to docs/Makefile diff --git a/documentation/source/_static/.git-dont-delete b/docs/source/_static/.git-dont-delete similarity index 100% rename from documentation/source/_static/.git-dont-delete rename to docs/source/_static/.git-dont-delete diff --git a/documentation/source/_templates/.git-dont-delete b/docs/source/_templates/.git-dont-delete similarity index 100% rename from documentation/source/_templates/.git-dont-delete rename to docs/source/_templates/.git-dont-delete diff --git a/documentation/source/changelog.rst b/docs/source/changelog.rst similarity index 100% rename from documentation/source/changelog.rst rename to docs/source/changelog.rst diff --git a/documentation/source/code-of-conduct.rst b/docs/source/code-of-conduct.rst similarity index 100% rename from documentation/source/code-of-conduct.rst rename to docs/source/code-of-conduct.rst diff --git a/documentation/source/conf.py b/docs/source/conf.py similarity index 100% rename from documentation/source/conf.py rename to docs/source/conf.py diff --git a/documentation/source/contribute.rst b/docs/source/contribute.rst similarity index 100% rename from documentation/source/contribute.rst rename to docs/source/contribute.rst diff --git a/documentation/source/example.rst b/docs/source/example.rst similarity index 100% rename from documentation/source/example.rst rename to docs/source/example.rst diff --git a/documentation/source/index.rst b/docs/source/index.rst similarity index 100% rename from documentation/source/index.rst rename to docs/source/index.rst diff --git a/documentation/source/install.rst b/docs/source/install.rst similarity index 100% rename from documentation/source/install.rst rename to docs/source/install.rst diff --git a/documentation/source/modules-api.rst b/docs/source/modules-api.rst similarity index 100% rename from documentation/source/modules-api.rst rename to docs/source/modules-api.rst diff --git a/documentation/source/other-impls.rst b/docs/source/other-impls.rst similarity index 100% rename from documentation/source/other-impls.rst rename to docs/source/other-impls.rst diff --git a/documentation/source/upgrade.rst b/docs/source/upgrade.rst similarity index 100% rename from documentation/source/upgrade.rst rename to docs/source/upgrade.rst diff --git a/setup.cfg b/setup.cfg index c3aab4a..d02e540 100644 --- a/setup.cfg +++ b/setup.cfg @@ -54,8 +54,8 @@ where = . [build_sphinx] all_files = 1 -build-dir = documentation/build -source-dir = documentation/source +build-dir = docs/build +source-dir = docs/source warning-is-error = True [options.extras_require] diff --git a/tox.ini b/tox.ini index 8643c66..6a0d1b9 100644 --- a/tox.ini +++ b/tox.ini @@ -49,6 +49,12 @@ skipdist = True extras = docs commands = python -m setup build_sphinx +[testenv:docs-livereload] +description = invoke sphinx-autobuild to build and reload the documentation +commands = python -m sphinx_autobuild docs/source docs/build +deps = sphinx-autobuild>=0.7.1,<1.0 +extras = docs + [testenv:changelog] description = draw up the new changelog skipdist = True