diff --git a/.gitignore b/.gitignore index 3b41547c..4240cccb 100644 --- a/.gitignore +++ b/.gitignore @@ -67,8 +67,8 @@ instance/ .scrapy # Sphinx documentation -doc/_build/ -doc/source/_static/ +docs/_build/ +docs/source/_static/ # PyBuilder target/ diff --git a/doc/requirements.txt b/docs/requirements.txt similarity index 100% rename from doc/requirements.txt rename to docs/requirements.txt diff --git a/doc/source/HACKING.rst b/docs/source/HACKING.rst similarity index 100% rename from doc/source/HACKING.rst rename to docs/source/HACKING.rst 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_client.rst b/docs/source/api_client.rst similarity index 100% rename from doc/source/api_client.rst rename to docs/source/api_client.rst diff --git a/doc/source/api_ref.rst b/docs/source/api_ref.rst similarity index 100% rename from doc/source/api_ref.rst rename to docs/source/api_ref.rst diff --git a/doc/source/conf.py b/docs/source/conf.py similarity index 100% rename from doc/source/conf.py rename to docs/source/conf.py diff --git a/doc/source/document_types.rst b/docs/source/document_types.rst similarity index 100% rename from doc/source/document_types.rst rename to docs/source/document_types.rst diff --git a/doc/source/documents.rst b/docs/source/documents.rst similarity index 100% rename from doc/source/documents.rst rename to docs/source/documents.rst diff --git a/doc/source/exceptions.rst b/docs/source/exceptions.rst similarity index 100% rename from doc/source/exceptions.rst rename to docs/source/exceptions.rst diff --git a/doc/source/getting-started.rst b/docs/source/getting-started.rst similarity index 100% rename from doc/source/getting-started.rst rename to docs/source/getting-started.rst diff --git a/doc/source/glossary.rst b/docs/source/glossary.rst similarity index 100% rename from doc/source/glossary.rst rename to docs/source/glossary.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/layering.rst b/docs/source/layering.rst similarity index 100% rename from doc/source/layering.rst rename to docs/source/layering.rst diff --git a/doc/source/overview.rst b/docs/source/overview.rst similarity index 100% rename from doc/source/overview.rst rename to docs/source/overview.rst diff --git a/doc/source/policy-enforcement.rst b/docs/source/policy-enforcement.rst similarity index 100% rename from doc/source/policy-enforcement.rst rename to docs/source/policy-enforcement.rst diff --git a/doc/source/revision_history.rst b/docs/source/revision_history.rst similarity index 100% rename from doc/source/revision_history.rst rename to docs/source/revision_history.rst diff --git a/doc/source/substitution.rst b/docs/source/substitution.rst similarity index 100% rename from doc/source/substitution.rst rename to docs/source/substitution.rst diff --git a/doc/source/testing.rst b/docs/source/testing.rst similarity index 100% rename from doc/source/testing.rst rename to docs/source/testing.rst diff --git a/doc/source/validation.rst b/docs/source/validation.rst similarity index 100% rename from doc/source/validation.rst rename to docs/source/validation.rst diff --git a/setup.cfg b/setup.cfg index 0779faf2..109eea28 100644 --- a/setup.cfg +++ b/setup.cfg @@ -28,8 +28,8 @@ oslo.policy.policies = deckhand = deckhand.policies:list_rules [build_sphinx] -source-dir = doc/source -build-dir = doc/build +source-dir = docs/source +build-dir = docs/build all_files = 1 warning-is-error = 1 diff --git a/tox.ini b/tox.ini index 28ab69ee..6a757b73 100644 --- a/tox.ini +++ b/tox.ini @@ -62,7 +62,7 @@ commands = bandit -r deckhand -x deckhand/tests -n 5 [testenv:releasenotes] -deps = -r{toxinidir}/doc/requirements.txt +deps = -r{toxinidir}/docs/requirements.txt commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html [testenv:genconfig] @@ -83,10 +83,10 @@ commands = flake8 {posargs} # [H904] Delay string interpolations at logging calls. enable-extensions = H106,H203,H204,H205,H210,H904 ignore = E127,E128,E129,E131,H405 -exclude = .venv,.git,.tox,dist,*lib/python*,*egg,build,releasenotes,doc +exclude = .venv,.git,.tox,dist,*lib/python*,*egg,build,releasenotes,docs [testenv:docs] -deps = -r{toxinidir}/doc/requirements.txt +deps = -r{toxinidir}/docs/requirements.txt commands = - rm -rf doc/build + rm -rf docs/build python setup.py build_sphinx {posargs}