From 085d9887e06694609b1b6000c29c36a65b02534d Mon Sep 17 00:00:00 2001 From: Felipe Monteiro Date: Thu, 17 May 2018 19:34:42 +0100 Subject: [PATCH] Rename docs to doc to align with OpenStack standard This patchset updates docs to doc to align with OpenStack standard. Follow-up patchset will be needed to publish documentation to OpenStack [0]. TODO: Update Armada documentation job to align with [1]. [0] https://docs.openstack.org/doc-contrib-guide/project-guides.html [1] http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Change-Id: I100541611ddfcd5c42f09da631346cb8ef3de5e7 --- .gitignore | 4 ++-- {docs => doc}/source/_static/.placeholder | 0 {docs => doc}/source/commands/apply.rst | 0 {docs => doc}/source/commands/index.rst | 0 {docs => doc}/source/commands/test.rst | 0 {docs => doc}/source/commands/tiller.rst | 0 {docs => doc}/source/commands/validate.rst | 0 {docs => doc}/source/conf.py | 0 {docs => doc}/source/development/contributing.rst | 0 {docs => doc}/source/development/getting-started.rst | 0 {docs => doc}/source/development/index.rst | 0 {docs => doc}/source/index.rst | 0 {docs => doc}/source/operations/exceptions/api-exceptions.inc | 0 .../source/operations/exceptions/armada-exceptions.inc | 0 .../source/operations/exceptions/base-exceptions.inc | 0 .../source/operations/exceptions/chartbuilder-exceptions.inc | 0 .../source/operations/exceptions/guide-exceptions.rst | 0 {docs => doc}/source/operations/exceptions/index.rst | 0 {docs => doc}/source/operations/exceptions/k8s-exceptions.inc | 0 .../source/operations/exceptions/manifest-exceptions.inc | 0 .../source/operations/exceptions/override-exceptions.inc | 0 .../source/operations/exceptions/source-exceptions.inc | 0 .../source/operations/exceptions/tiller-exceptions.inc | 0 .../source/operations/exceptions/validate-exceptions.inc | 0 {docs => doc}/source/operations/guide-api.rst | 0 {docs => doc}/source/operations/guide-build-armada-yaml.rst | 0 {docs => doc}/source/operations/guide-configure.rst | 0 {docs => doc}/source/operations/guide-helm-plugin.rst | 0 {docs => doc}/source/operations/guide-troubleshooting.rst | 0 {docs => doc}/source/operations/guide-use-armada.rst | 0 {docs => doc}/source/operations/index.rst | 0 {docs => doc}/source/operations/sampleconf.rst | 0 {docs => doc}/source/operations/samplepolicy.rst | 0 {docs => doc}/source/operations/validation.rst | 0 {docs => doc}/source/readme.rst | 0 setup.cfg | 4 ++-- tox.ini | 2 +- 37 files changed, 5 insertions(+), 5 deletions(-) rename {docs => doc}/source/_static/.placeholder (100%) rename {docs => doc}/source/commands/apply.rst (100%) rename {docs => doc}/source/commands/index.rst (100%) rename {docs => doc}/source/commands/test.rst (100%) rename {docs => doc}/source/commands/tiller.rst (100%) rename {docs => doc}/source/commands/validate.rst (100%) rename {docs => doc}/source/conf.py (100%) rename {docs => doc}/source/development/contributing.rst (100%) rename {docs => doc}/source/development/getting-started.rst (100%) rename {docs => doc}/source/development/index.rst (100%) rename {docs => doc}/source/index.rst (100%) rename {docs => doc}/source/operations/exceptions/api-exceptions.inc (100%) rename {docs => doc}/source/operations/exceptions/armada-exceptions.inc (100%) rename {docs => doc}/source/operations/exceptions/base-exceptions.inc (100%) rename {docs => doc}/source/operations/exceptions/chartbuilder-exceptions.inc (100%) rename {docs => doc}/source/operations/exceptions/guide-exceptions.rst (100%) rename {docs => doc}/source/operations/exceptions/index.rst (100%) rename {docs => doc}/source/operations/exceptions/k8s-exceptions.inc (100%) rename {docs => doc}/source/operations/exceptions/manifest-exceptions.inc (100%) rename {docs => doc}/source/operations/exceptions/override-exceptions.inc (100%) rename {docs => doc}/source/operations/exceptions/source-exceptions.inc (100%) rename {docs => doc}/source/operations/exceptions/tiller-exceptions.inc (100%) rename {docs => doc}/source/operations/exceptions/validate-exceptions.inc (100%) rename {docs => doc}/source/operations/guide-api.rst (100%) rename {docs => doc}/source/operations/guide-build-armada-yaml.rst (100%) rename {docs => doc}/source/operations/guide-configure.rst (100%) rename {docs => doc}/source/operations/guide-helm-plugin.rst (100%) rename {docs => doc}/source/operations/guide-troubleshooting.rst (100%) rename {docs => doc}/source/operations/guide-use-armada.rst (100%) rename {docs => doc}/source/operations/index.rst (100%) rename {docs => doc}/source/operations/sampleconf.rst (100%) rename {docs => doc}/source/operations/samplepolicy.rst (100%) rename {docs => doc}/source/operations/validation.rst (100%) rename {docs => doc}/source/readme.rst (100%) diff --git a/.gitignore b/.gitignore index d333a39a..2ea4403e 100644 --- a/.gitignore +++ b/.gitignore @@ -65,8 +65,8 @@ instance/ .scrapy # Sphinx documentation -docs/build/ -docs/source/_static +doc/build/ +doc/source/_static # PyBuilder target/ diff --git a/docs/source/_static/.placeholder b/doc/source/_static/.placeholder similarity index 100% rename from docs/source/_static/.placeholder rename to doc/source/_static/.placeholder diff --git a/docs/source/commands/apply.rst b/doc/source/commands/apply.rst similarity index 100% rename from docs/source/commands/apply.rst rename to doc/source/commands/apply.rst diff --git a/docs/source/commands/index.rst b/doc/source/commands/index.rst similarity index 100% rename from docs/source/commands/index.rst rename to doc/source/commands/index.rst diff --git a/docs/source/commands/test.rst b/doc/source/commands/test.rst similarity index 100% rename from docs/source/commands/test.rst rename to doc/source/commands/test.rst diff --git a/docs/source/commands/tiller.rst b/doc/source/commands/tiller.rst similarity index 100% rename from docs/source/commands/tiller.rst rename to doc/source/commands/tiller.rst diff --git a/docs/source/commands/validate.rst b/doc/source/commands/validate.rst similarity index 100% rename from docs/source/commands/validate.rst rename to doc/source/commands/validate.rst diff --git a/docs/source/conf.py b/doc/source/conf.py similarity index 100% rename from docs/source/conf.py rename to doc/source/conf.py diff --git a/docs/source/development/contributing.rst b/doc/source/development/contributing.rst similarity index 100% rename from docs/source/development/contributing.rst rename to doc/source/development/contributing.rst diff --git a/docs/source/development/getting-started.rst b/doc/source/development/getting-started.rst similarity index 100% rename from docs/source/development/getting-started.rst rename to doc/source/development/getting-started.rst diff --git a/docs/source/development/index.rst b/doc/source/development/index.rst similarity index 100% rename from docs/source/development/index.rst rename to doc/source/development/index.rst diff --git a/docs/source/index.rst b/doc/source/index.rst similarity index 100% rename from docs/source/index.rst rename to doc/source/index.rst diff --git a/docs/source/operations/exceptions/api-exceptions.inc b/doc/source/operations/exceptions/api-exceptions.inc similarity index 100% rename from docs/source/operations/exceptions/api-exceptions.inc rename to doc/source/operations/exceptions/api-exceptions.inc diff --git a/docs/source/operations/exceptions/armada-exceptions.inc b/doc/source/operations/exceptions/armada-exceptions.inc similarity index 100% rename from docs/source/operations/exceptions/armada-exceptions.inc rename to doc/source/operations/exceptions/armada-exceptions.inc diff --git a/docs/source/operations/exceptions/base-exceptions.inc b/doc/source/operations/exceptions/base-exceptions.inc similarity index 100% rename from docs/source/operations/exceptions/base-exceptions.inc rename to doc/source/operations/exceptions/base-exceptions.inc diff --git a/docs/source/operations/exceptions/chartbuilder-exceptions.inc b/doc/source/operations/exceptions/chartbuilder-exceptions.inc similarity index 100% rename from docs/source/operations/exceptions/chartbuilder-exceptions.inc rename to doc/source/operations/exceptions/chartbuilder-exceptions.inc diff --git a/docs/source/operations/exceptions/guide-exceptions.rst b/doc/source/operations/exceptions/guide-exceptions.rst similarity index 100% rename from docs/source/operations/exceptions/guide-exceptions.rst rename to doc/source/operations/exceptions/guide-exceptions.rst diff --git a/docs/source/operations/exceptions/index.rst b/doc/source/operations/exceptions/index.rst similarity index 100% rename from docs/source/operations/exceptions/index.rst rename to doc/source/operations/exceptions/index.rst diff --git a/docs/source/operations/exceptions/k8s-exceptions.inc b/doc/source/operations/exceptions/k8s-exceptions.inc similarity index 100% rename from docs/source/operations/exceptions/k8s-exceptions.inc rename to doc/source/operations/exceptions/k8s-exceptions.inc diff --git a/docs/source/operations/exceptions/manifest-exceptions.inc b/doc/source/operations/exceptions/manifest-exceptions.inc similarity index 100% rename from docs/source/operations/exceptions/manifest-exceptions.inc rename to doc/source/operations/exceptions/manifest-exceptions.inc diff --git a/docs/source/operations/exceptions/override-exceptions.inc b/doc/source/operations/exceptions/override-exceptions.inc similarity index 100% rename from docs/source/operations/exceptions/override-exceptions.inc rename to doc/source/operations/exceptions/override-exceptions.inc diff --git a/docs/source/operations/exceptions/source-exceptions.inc b/doc/source/operations/exceptions/source-exceptions.inc similarity index 100% rename from docs/source/operations/exceptions/source-exceptions.inc rename to doc/source/operations/exceptions/source-exceptions.inc diff --git a/docs/source/operations/exceptions/tiller-exceptions.inc b/doc/source/operations/exceptions/tiller-exceptions.inc similarity index 100% rename from docs/source/operations/exceptions/tiller-exceptions.inc rename to doc/source/operations/exceptions/tiller-exceptions.inc diff --git a/docs/source/operations/exceptions/validate-exceptions.inc b/doc/source/operations/exceptions/validate-exceptions.inc similarity index 100% rename from docs/source/operations/exceptions/validate-exceptions.inc rename to doc/source/operations/exceptions/validate-exceptions.inc diff --git a/docs/source/operations/guide-api.rst b/doc/source/operations/guide-api.rst similarity index 100% rename from docs/source/operations/guide-api.rst rename to doc/source/operations/guide-api.rst diff --git a/docs/source/operations/guide-build-armada-yaml.rst b/doc/source/operations/guide-build-armada-yaml.rst similarity index 100% rename from docs/source/operations/guide-build-armada-yaml.rst rename to doc/source/operations/guide-build-armada-yaml.rst diff --git a/docs/source/operations/guide-configure.rst b/doc/source/operations/guide-configure.rst similarity index 100% rename from docs/source/operations/guide-configure.rst rename to doc/source/operations/guide-configure.rst diff --git a/docs/source/operations/guide-helm-plugin.rst b/doc/source/operations/guide-helm-plugin.rst similarity index 100% rename from docs/source/operations/guide-helm-plugin.rst rename to doc/source/operations/guide-helm-plugin.rst diff --git a/docs/source/operations/guide-troubleshooting.rst b/doc/source/operations/guide-troubleshooting.rst similarity index 100% rename from docs/source/operations/guide-troubleshooting.rst rename to doc/source/operations/guide-troubleshooting.rst diff --git a/docs/source/operations/guide-use-armada.rst b/doc/source/operations/guide-use-armada.rst similarity index 100% rename from docs/source/operations/guide-use-armada.rst rename to doc/source/operations/guide-use-armada.rst diff --git a/docs/source/operations/index.rst b/doc/source/operations/index.rst similarity index 100% rename from docs/source/operations/index.rst rename to doc/source/operations/index.rst diff --git a/docs/source/operations/sampleconf.rst b/doc/source/operations/sampleconf.rst similarity index 100% rename from docs/source/operations/sampleconf.rst rename to doc/source/operations/sampleconf.rst diff --git a/docs/source/operations/samplepolicy.rst b/doc/source/operations/samplepolicy.rst similarity index 100% rename from docs/source/operations/samplepolicy.rst rename to doc/source/operations/samplepolicy.rst diff --git a/docs/source/operations/validation.rst b/doc/source/operations/validation.rst similarity index 100% rename from docs/source/operations/validation.rst rename to doc/source/operations/validation.rst diff --git a/docs/source/readme.rst b/doc/source/readme.rst similarity index 100% rename from docs/source/readme.rst rename to doc/source/readme.rst diff --git a/setup.cfg b/setup.cfg index e8e790c0..bf3ddea7 100644 --- a/setup.cfg +++ b/setup.cfg @@ -27,8 +27,8 @@ packages = hapi.version [build_sphinx] -source-dir = docs/source -build-dir = docs/build +source-dir = doc/source +build-dir = doc/build all_files = 1 warning-is-error = 1 diff --git a/tox.ini b/tox.ini index c464841f..3fb3b87b 100644 --- a/tox.ini +++ b/tox.ini @@ -56,4 +56,4 @@ commands = [flake8] filename = *.py ignore = -exclude = .git,.tox,dist,*lib/python*,*egg,build,releasenotes,docs/*,hapi,venv +exclude = .git,.tox,dist,*lib/python*,*egg,build,releasenotes,doc/*,hapi,venv