From 13bc298f609f738eaced747eca15f872e8bd4d32 Mon Sep 17 00:00:00 2001 From: Felipe Monteiro Date: Thu, 17 May 2018 19:39:27 +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]. [0] https://docs.openstack.org/doc-contrib-guide/project-guides.html Change-Id: I0f2346801bc3749e74fcc3104cc2258626747185 --- .gitignore | 4 ++-- {docs => doc}/source/api.rst | 0 {docs => doc}/source/conf.py | 0 {docs => doc}/source/configuration/docker.rst | 0 {docs => doc}/source/configuration/genesis.rst | 0 {docs => doc}/source/configuration/host-system.rst | 0 {docs => doc}/source/configuration/index.rst | 0 {docs => doc}/source/configuration/kubelet.rst | 0 {docs => doc}/source/configuration/kubernetes-network.rst | 0 {docs => doc}/source/configuration/kubernetes-node.rst | 0 {docs => doc}/source/configuration/pki-catalog.rst | 0 {docs => doc}/source/design.rst | 0 {docs => doc}/source/exceptions.rst | 0 {docs => doc}/source/getting-started.rst | 0 {docs => doc}/source/index.rst | 0 {docs => doc}/source/troubleshooting/genesis.rst | 0 {docs => doc}/source/troubleshooting/index.rst | 0 tox.ini | 4 ++-- 18 files changed, 4 insertions(+), 4 deletions(-) rename {docs => doc}/source/api.rst (100%) rename {docs => doc}/source/conf.py (100%) rename {docs => doc}/source/configuration/docker.rst (100%) rename {docs => doc}/source/configuration/genesis.rst (100%) rename {docs => doc}/source/configuration/host-system.rst (100%) rename {docs => doc}/source/configuration/index.rst (100%) rename {docs => doc}/source/configuration/kubelet.rst (100%) rename {docs => doc}/source/configuration/kubernetes-network.rst (100%) rename {docs => doc}/source/configuration/kubernetes-node.rst (100%) rename {docs => doc}/source/configuration/pki-catalog.rst (100%) rename {docs => doc}/source/design.rst (100%) rename {docs => doc}/source/exceptions.rst (100%) rename {docs => doc}/source/getting-started.rst (100%) rename {docs => doc}/source/index.rst (100%) rename {docs => doc}/source/troubleshooting/genesis.rst (100%) rename {docs => doc}/source/troubleshooting/index.rst (100%) diff --git a/.gitignore b/.gitignore index 528ef0b2..3263f78f 100644 --- a/.gitignore +++ b/.gitignore @@ -19,8 +19,8 @@ __pycache__ # Sphinx artifacts -/docs/build/ -/docs/*/_static/ +/doc/build/ +/doc/*/_static/ /AUTHORS /ChangeLog diff --git a/docs/source/api.rst b/doc/source/api.rst similarity index 100% rename from docs/source/api.rst rename to doc/source/api.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/configuration/docker.rst b/doc/source/configuration/docker.rst similarity index 100% rename from docs/source/configuration/docker.rst rename to doc/source/configuration/docker.rst diff --git a/docs/source/configuration/genesis.rst b/doc/source/configuration/genesis.rst similarity index 100% rename from docs/source/configuration/genesis.rst rename to doc/source/configuration/genesis.rst diff --git a/docs/source/configuration/host-system.rst b/doc/source/configuration/host-system.rst similarity index 100% rename from docs/source/configuration/host-system.rst rename to doc/source/configuration/host-system.rst diff --git a/docs/source/configuration/index.rst b/doc/source/configuration/index.rst similarity index 100% rename from docs/source/configuration/index.rst rename to doc/source/configuration/index.rst diff --git a/docs/source/configuration/kubelet.rst b/doc/source/configuration/kubelet.rst similarity index 100% rename from docs/source/configuration/kubelet.rst rename to doc/source/configuration/kubelet.rst diff --git a/docs/source/configuration/kubernetes-network.rst b/doc/source/configuration/kubernetes-network.rst similarity index 100% rename from docs/source/configuration/kubernetes-network.rst rename to doc/source/configuration/kubernetes-network.rst diff --git a/docs/source/configuration/kubernetes-node.rst b/doc/source/configuration/kubernetes-node.rst similarity index 100% rename from docs/source/configuration/kubernetes-node.rst rename to doc/source/configuration/kubernetes-node.rst diff --git a/docs/source/configuration/pki-catalog.rst b/doc/source/configuration/pki-catalog.rst similarity index 100% rename from docs/source/configuration/pki-catalog.rst rename to doc/source/configuration/pki-catalog.rst diff --git a/docs/source/design.rst b/doc/source/design.rst similarity index 100% rename from docs/source/design.rst rename to doc/source/design.rst diff --git a/docs/source/exceptions.rst b/doc/source/exceptions.rst similarity index 100% rename from docs/source/exceptions.rst rename to doc/source/exceptions.rst diff --git a/docs/source/getting-started.rst b/doc/source/getting-started.rst similarity index 100% rename from docs/source/getting-started.rst rename to doc/source/getting-started.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/troubleshooting/genesis.rst b/doc/source/troubleshooting/genesis.rst similarity index 100% rename from docs/source/troubleshooting/genesis.rst rename to doc/source/troubleshooting/genesis.rst diff --git a/docs/source/troubleshooting/index.rst b/doc/source/troubleshooting/index.rst similarity index 100% rename from docs/source/troubleshooting/index.rst rename to doc/source/troubleshooting/index.rst diff --git a/tox.ini b/tox.ini index cd2b4f31..8ced46ae 100644 --- a/tox.ini +++ b/tox.ini @@ -25,8 +25,8 @@ deps = -r{toxinidir}/requirements-frozen.txt -r{toxinidir}/test-requirements.txt commands = - rm -rf docs/build - sphinx-build -b html docs/source docs/build + rm -rf doc/build + sphinx-build -b html doc/source doc/build [testenv:fmt] deps = yapf==0.20.0