From 0cbddea50d9651342647884bf9b8733354238884 Mon Sep 17 00:00:00 2001 From: Monty Taylor Date: Tue, 7 Oct 2014 13:25:01 -0700 Subject: [PATCH] Move the doc paths to match other repos In order to build in the Infra system, we'd like to be able to reuse the existing doc build macros. To support that, move docs/source to doc/source and docs/html to doc/build/html. Change-Id: Ibd8e8e82e54c69b182120df67e6ec6908fed2908 --- .gitignore | 4 ++-- {docs => doc}/source/assets/css/bootstrap.css | 0 {docs => doc}/source/assets/css/local.css | 0 {docs => doc}/source/assets/images/devstack.png | Bin {docs => doc}/source/assets/images/header_bg.png | Bin {docs => doc}/source/assets/images/logo.png | Bin {docs => doc}/source/assets/images/quickstart.png | Bin {docs => doc}/source/assets/images/small_logo.png | Bin {docs => doc}/source/assets/js/bootstrap.js | 0 {docs => doc}/source/assets/js/bootstrap.min.js | 0 {docs => doc}/source/assets/js/jquery-1.7.1.min.js | 0 {docs => doc}/source/changes.html | 0 {docs => doc}/source/configuration.html | 0 {docs => doc}/source/contributing.html | 0 {docs => doc}/source/eucarc.html | 0 {docs => doc}/source/exerciserc.html | 0 {docs => doc}/source/faq.html | 0 {docs => doc}/source/guides/multinode-lab.html | 0 {docs => doc}/source/guides/pxe-boot.html | 0 {docs => doc}/source/guides/ramdisk.html | 0 {docs => doc}/source/guides/single-machine.html | 0 {docs => doc}/source/guides/single-vm.html | 0 {docs => doc}/source/guides/usb-boot.html | 0 {docs => doc}/source/index.html | 0 {docs => doc}/source/local.conf.html | 0 {docs => doc}/source/localrc.html | 0 {docs => doc}/source/openrc.html | 0 {docs => doc}/source/overview.html | 0 {docs => doc}/source/plugins.html | 0 {docs => doc}/source/stackrc.html | 0 tools/build_docs.sh | 8 ++++---- 31 files changed, 6 insertions(+), 6 deletions(-) rename {docs => doc}/source/assets/css/bootstrap.css (100%) rename {docs => doc}/source/assets/css/local.css (100%) rename {docs => doc}/source/assets/images/devstack.png (100%) rename {docs => doc}/source/assets/images/header_bg.png (100%) rename {docs => doc}/source/assets/images/logo.png (100%) rename {docs => doc}/source/assets/images/quickstart.png (100%) rename {docs => doc}/source/assets/images/small_logo.png (100%) rename {docs => doc}/source/assets/js/bootstrap.js (100%) rename {docs => doc}/source/assets/js/bootstrap.min.js (100%) rename {docs => doc}/source/assets/js/jquery-1.7.1.min.js (100%) rename {docs => doc}/source/changes.html (100%) rename {docs => doc}/source/configuration.html (100%) rename {docs => doc}/source/contributing.html (100%) rename {docs => doc}/source/eucarc.html (100%) rename {docs => doc}/source/exerciserc.html (100%) rename {docs => doc}/source/faq.html (100%) rename {docs => doc}/source/guides/multinode-lab.html (100%) rename {docs => doc}/source/guides/pxe-boot.html (100%) rename {docs => doc}/source/guides/ramdisk.html (100%) rename {docs => doc}/source/guides/single-machine.html (100%) rename {docs => doc}/source/guides/single-vm.html (100%) rename {docs => doc}/source/guides/usb-boot.html (100%) rename {docs => doc}/source/index.html (100%) rename {docs => doc}/source/local.conf.html (100%) rename {docs => doc}/source/localrc.html (100%) rename {docs => doc}/source/openrc.html (100%) rename {docs => doc}/source/overview.html (100%) rename {docs => doc}/source/plugins.html (100%) rename {docs => doc}/source/stackrc.html (100%) diff --git a/.gitignore b/.gitignore index b0a65f59cd..67ab722190 100644 --- a/.gitignore +++ b/.gitignore @@ -8,8 +8,8 @@ .tox .stackenv accrc -docs/files -docs/html +doc/files +doc/build files/*.gz files/*.qcow2 files/images diff --git a/docs/source/assets/css/bootstrap.css b/doc/source/assets/css/bootstrap.css similarity index 100% rename from docs/source/assets/css/bootstrap.css rename to doc/source/assets/css/bootstrap.css diff --git a/docs/source/assets/css/local.css b/doc/source/assets/css/local.css similarity index 100% rename from docs/source/assets/css/local.css rename to doc/source/assets/css/local.css diff --git a/docs/source/assets/images/devstack.png b/doc/source/assets/images/devstack.png similarity index 100% rename from docs/source/assets/images/devstack.png rename to doc/source/assets/images/devstack.png diff --git a/docs/source/assets/images/header_bg.png b/doc/source/assets/images/header_bg.png similarity index 100% rename from docs/source/assets/images/header_bg.png rename to doc/source/assets/images/header_bg.png diff --git a/docs/source/assets/images/logo.png b/doc/source/assets/images/logo.png similarity index 100% rename from docs/source/assets/images/logo.png rename to doc/source/assets/images/logo.png diff --git a/docs/source/assets/images/quickstart.png b/doc/source/assets/images/quickstart.png similarity index 100% rename from docs/source/assets/images/quickstart.png rename to doc/source/assets/images/quickstart.png diff --git a/docs/source/assets/images/small_logo.png b/doc/source/assets/images/small_logo.png similarity index 100% rename from docs/source/assets/images/small_logo.png rename to doc/source/assets/images/small_logo.png diff --git a/docs/source/assets/js/bootstrap.js b/doc/source/assets/js/bootstrap.js similarity index 100% rename from docs/source/assets/js/bootstrap.js rename to doc/source/assets/js/bootstrap.js diff --git a/docs/source/assets/js/bootstrap.min.js b/doc/source/assets/js/bootstrap.min.js similarity index 100% rename from docs/source/assets/js/bootstrap.min.js rename to doc/source/assets/js/bootstrap.min.js diff --git a/docs/source/assets/js/jquery-1.7.1.min.js b/doc/source/assets/js/jquery-1.7.1.min.js similarity index 100% rename from docs/source/assets/js/jquery-1.7.1.min.js rename to doc/source/assets/js/jquery-1.7.1.min.js diff --git a/docs/source/changes.html b/doc/source/changes.html similarity index 100% rename from docs/source/changes.html rename to doc/source/changes.html diff --git a/docs/source/configuration.html b/doc/source/configuration.html similarity index 100% rename from docs/source/configuration.html rename to doc/source/configuration.html diff --git a/docs/source/contributing.html b/doc/source/contributing.html similarity index 100% rename from docs/source/contributing.html rename to doc/source/contributing.html diff --git a/docs/source/eucarc.html b/doc/source/eucarc.html similarity index 100% rename from docs/source/eucarc.html rename to doc/source/eucarc.html diff --git a/docs/source/exerciserc.html b/doc/source/exerciserc.html similarity index 100% rename from docs/source/exerciserc.html rename to doc/source/exerciserc.html diff --git a/docs/source/faq.html b/doc/source/faq.html similarity index 100% rename from docs/source/faq.html rename to doc/source/faq.html diff --git a/docs/source/guides/multinode-lab.html b/doc/source/guides/multinode-lab.html similarity index 100% rename from docs/source/guides/multinode-lab.html rename to doc/source/guides/multinode-lab.html diff --git a/docs/source/guides/pxe-boot.html b/doc/source/guides/pxe-boot.html similarity index 100% rename from docs/source/guides/pxe-boot.html rename to doc/source/guides/pxe-boot.html diff --git a/docs/source/guides/ramdisk.html b/doc/source/guides/ramdisk.html similarity index 100% rename from docs/source/guides/ramdisk.html rename to doc/source/guides/ramdisk.html diff --git a/docs/source/guides/single-machine.html b/doc/source/guides/single-machine.html similarity index 100% rename from docs/source/guides/single-machine.html rename to doc/source/guides/single-machine.html diff --git a/docs/source/guides/single-vm.html b/doc/source/guides/single-vm.html similarity index 100% rename from docs/source/guides/single-vm.html rename to doc/source/guides/single-vm.html diff --git a/docs/source/guides/usb-boot.html b/doc/source/guides/usb-boot.html similarity index 100% rename from docs/source/guides/usb-boot.html rename to doc/source/guides/usb-boot.html diff --git a/docs/source/index.html b/doc/source/index.html similarity index 100% rename from docs/source/index.html rename to doc/source/index.html diff --git a/docs/source/local.conf.html b/doc/source/local.conf.html similarity index 100% rename from docs/source/local.conf.html rename to doc/source/local.conf.html diff --git a/docs/source/localrc.html b/doc/source/localrc.html similarity index 100% rename from docs/source/localrc.html rename to doc/source/localrc.html diff --git a/docs/source/openrc.html b/doc/source/openrc.html similarity index 100% rename from docs/source/openrc.html rename to doc/source/openrc.html diff --git a/docs/source/overview.html b/doc/source/overview.html similarity index 100% rename from docs/source/overview.html rename to doc/source/overview.html diff --git a/docs/source/plugins.html b/doc/source/plugins.html similarity index 100% rename from docs/source/plugins.html rename to doc/source/plugins.html diff --git a/docs/source/stackrc.html b/doc/source/stackrc.html similarity index 100% rename from docs/source/stackrc.html rename to doc/source/stackrc.html diff --git a/tools/build_docs.sh b/tools/build_docs.sh index 96bd8924d6..f52b179b7e 100755 --- a/tools/build_docs.sh +++ b/tools/build_docs.sh @@ -4,7 +4,7 @@ # # - Install shocco if not found on PATH and INSTALL_SHOCCO is set # - Clone MASTER_REPO branch MASTER_BRANCH -# - Re-creates ``docs/html`` directory from existing repo + new generated script docs +# - Re-creates ``doc/build/html`` directory from existing repo + new generated script docs # Usage: ## build_docs.sh [-o ] [-g] [master| []] @@ -29,8 +29,8 @@ MASTER_BRANCH=${MASTER_BRANCH:-master} # http://devstack.org is a GitHub gh-pages site in the https://github.com/cloudbuilders/devtack.git repo GH_PAGES_REPO=git@github.com:cloudbuilders/devstack.git -DOCS_SOURCE=docs/source -HTML_BUILD=docs/html +DOCS_SOURCE=doc/source +HTML_BUILD=doc/build/html # Keep track of the devstack directory TOP_DIR=$(cd $(dirname "$0")/.. && pwd) @@ -136,7 +136,7 @@ for f in $(find functions functions-common lib samples -type f -name \*); do mkdir -p $FQ_HTML_BUILD/`dirname $f`; $SHOCCO $f > $FQ_HTML_BUILD/$f.html done -echo "$FILES" >docs/files +echo "$FILES" >doc/files if [[ -n $GH_UPDATE ]]; then GH_ROOT=$(mktemp -d work-gh-XXXX)