From f5fc46c7afe6bf7c134437257c767844b3c864f0 Mon Sep 17 00:00:00 2001 From: Felipe Monteiro Date: Wed, 6 Jun 2018 09:22:16 -0400 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: I90e5f9129207901402e26ed9488ec6e065568fe1 --- {docs => doc}/requirements.txt | 0 {docs => doc}/source/artifacts.rst | 0 {docs => doc}/source/authoring_strategy.rst | 0 {docs => doc}/source/cli.rst | 0 {docs => doc}/source/conf.py | 0 {docs => doc}/source/getting_started.rst | 0 {docs => doc}/source/index.rst | 0 tools/gate/playbooks/zuul-linter.yaml | 2 +- tox.ini | 4 ++-- 9 files changed, 3 insertions(+), 3 deletions(-) rename {docs => doc}/requirements.txt (100%) rename {docs => doc}/source/artifacts.rst (100%) rename {docs => doc}/source/authoring_strategy.rst (100%) rename {docs => doc}/source/cli.rst (100%) rename {docs => doc}/source/conf.py (100%) rename {docs => doc}/source/getting_started.rst (100%) rename {docs => doc}/source/index.rst (100%) diff --git a/docs/requirements.txt b/doc/requirements.txt similarity index 100% rename from docs/requirements.txt rename to doc/requirements.txt diff --git a/docs/source/artifacts.rst b/doc/source/artifacts.rst similarity index 100% rename from docs/source/artifacts.rst rename to doc/source/artifacts.rst diff --git a/docs/source/authoring_strategy.rst b/doc/source/authoring_strategy.rst similarity index 100% rename from docs/source/authoring_strategy.rst rename to doc/source/authoring_strategy.rst diff --git a/docs/source/cli.rst b/doc/source/cli.rst similarity index 100% rename from docs/source/cli.rst rename to doc/source/cli.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/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/tools/gate/playbooks/zuul-linter.yaml b/tools/gate/playbooks/zuul-linter.yaml index 05ee4a63..dd379553 100644 --- a/tools/gate/playbooks/zuul-linter.yaml +++ b/tools/gate/playbooks/zuul-linter.yaml @@ -15,6 +15,6 @@ - hosts: primary tasks: - name: Execute a Whitespace Linter check - command: find . -not -path "*/\.*" -not -path "*/docs/build/*" -not -name "*.tgz" -type f -exec egrep -l " +$" {} \; + command: find . -not -path "*/\.*" -not -path "*/doc/build/*" -not -name "*.tgz" -type f -exec egrep -l " +$" {} \; register: result failed_when: result.stdout != "" diff --git a/tox.ini b/tox.ini index 9e1c2902..a9456ec3 100644 --- a/tox.ini +++ b/tox.ini @@ -26,8 +26,8 @@ commands = whitelist_externals = tox [testenv:docs] -deps = -r{toxinidir}/docs/requirements.txt +deps = -r{toxinidir}/doc/requirements.txt commands = rm -rf doc/build - sphinx-build -b html docs/source docs/build -n -W -v + sphinx-build -b html doc/source doc/build -n -W -v whitelist_externals = rm