summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteven Dake <stdake@cisco.com>2015-09-02 22:33:01 -0700
committerSteven Dake <stdake@cisco.com>2015-09-02 22:37:36 -0700
commit233864ff32af10a2c927cdbca3475b537c8e6808 (patch)
tree99a0f159b60f736faa09871db363ebd5da1f7d8d
parent3ed7b3c3b4cb6c00cb9c3c55c9f00265e805d18f (diff)
downloadkolla-233864ff32af10a2c927cdbca3475b537c8e6808.tar.gz
kolla-233864ff32af10a2c927cdbca3475b537c8e6808.zip
Rename docs dir to doc for publishing
The publishing docs expect the documentation to be present in the /doc directory not the /docs directory. If the documentation is in the /docs directory, according to fungi the docs won't be published properly. Change-Id: I718fec7e69d298a5cb2376ca4e2455e12169566e Partially-Implements: blueprint kola-tox-doc
-rw-r--r--README.rst8
-rw-r--r--doc/ansible-deployment.rst (renamed from docs/ansible-deployment.rst)0
-rw-r--r--doc/cinder-guide.rst (renamed from docs/cinder-guide.rst)0
-rw-r--r--doc/conf.py (renamed from docs/conf.py)0
-rw-r--r--doc/dev-quickstart.rst (renamed from docs/dev-quickstart.rst)0
-rw-r--r--doc/devenv-heat.rst (renamed from docs/devenv-heat.rst)0
-rw-r--r--doc/devenv-vagrant.rst (renamed from docs/devenv-vagrant.rst)0
-rw-r--r--doc/image-building.rst (renamed from docs/image-building.rst)0
-rw-r--r--doc/index.rst (renamed from docs/index.rst)0
-rw-r--r--doc/kollanet.png (renamed from docs/kollanet.png)bin26014 -> 26014 bytes
-rw-r--r--doc/swift-readme.rst (renamed from docs/swift-readme.rst)0
-rw-r--r--setup.cfg6
12 files changed, 7 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index 7bcc693c8..a6051221f 100644
--- a/README.rst
+++ b/README.rst
@@ -21,9 +21,9 @@ Getting Started
===============
Please get started by reading the `Developer
-Quickstart <https://github.com/stackforge/kolla/blob/master/docs/dev-quickstart.rst>`__
+Quickstart <https://github.com/stackforge/kolla/blob/master/doc/dev-quickstart.rst>`__
followed by the `Ansible Deployment
-Guide <https://github.com/stackforge/kolla/blob/master/docs/ansible-deployment.rst>`__.
+Guide <https://github.com/stackforge/kolla/blob/master/doc/ansible-deployment.rst>`__.
Docker Images
-------------
@@ -31,7 +31,7 @@ Docker Images
The `Docker images <https://docs.docker.com/userguide/dockerimages/>`__
are built by the Kolla project maintainers. A detailed process for
contributing to the images can be found in the `image building
-guide <https://github.com/stackforge/kolla/blob/master/docs/image-building.rst>`__.
+guide <https://github.com/stackforge/kolla/blob/master/doc/image-building.rst>`__.
Images reside in the Docker Hub `Kollaglue
repo <https://registry.hub.docker.com/repos/kollaglue/>`__.
@@ -71,7 +71,7 @@ Directories
Ansible.
- demos - Contains a few demos to use with Kolla.
- devenv - Contains an OpenStack-Heat based development environment.
-- docs - Contains documentation.
+- doc - Contains documentation.
- etc - Contains a reference etc directory structure which requires
configuration of a small number of configuration variables to achieve
a working All-in-One (AIO) deployment.
diff --git a/docs/ansible-deployment.rst b/doc/ansible-deployment.rst
index 37a08a98a..37a08a98a 100644
--- a/docs/ansible-deployment.rst
+++ b/doc/ansible-deployment.rst
diff --git a/docs/cinder-guide.rst b/doc/cinder-guide.rst
index 7247cc02a..7247cc02a 100644
--- a/docs/cinder-guide.rst
+++ b/doc/cinder-guide.rst
diff --git a/docs/conf.py b/doc/conf.py
index a0d74bd97..a0d74bd97 100644
--- a/docs/conf.py
+++ b/doc/conf.py
diff --git a/docs/dev-quickstart.rst b/doc/dev-quickstart.rst
index e334a3ce5..e334a3ce5 100644
--- a/docs/dev-quickstart.rst
+++ b/doc/dev-quickstart.rst
diff --git a/docs/devenv-heat.rst b/doc/devenv-heat.rst
index 019fe7ebd..019fe7ebd 100644
--- a/docs/devenv-heat.rst
+++ b/doc/devenv-heat.rst
diff --git a/docs/devenv-vagrant.rst b/doc/devenv-vagrant.rst
index f3fe559aa..f3fe559aa 100644
--- a/docs/devenv-vagrant.rst
+++ b/doc/devenv-vagrant.rst
diff --git a/docs/image-building.rst b/doc/image-building.rst
index c118fef99..c118fef99 100644
--- a/docs/image-building.rst
+++ b/doc/image-building.rst
diff --git a/docs/index.rst b/doc/index.rst
index 258c6180a..258c6180a 100644
--- a/docs/index.rst
+++ b/doc/index.rst
diff --git a/docs/kollanet.png b/doc/kollanet.png
index cfb0c6014..cfb0c6014 100644
--- a/docs/kollanet.png
+++ b/doc/kollanet.png
Binary files differ
diff --git a/docs/swift-readme.rst b/doc/swift-readme.rst
index 9f8e19ecd..9f8e19ecd 100644
--- a/docs/swift-readme.rst
+++ b/doc/swift-readme.rst
diff --git a/setup.cfg b/setup.cfg
index 678776679..86514738f 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -24,7 +24,7 @@ data_files =
share/kolla/ansible = ansible/*
share/kolla/devenv = devenv/*
share/kolla/docker = docker/*
- share/kolla/docs = docs/*
+ share/kolla/doc = doc/*
share/kolla/etc_examples = etc/*
share/kolla/vagrant = vagrant/*
share/kolla = tools/init-runonce
@@ -45,5 +45,5 @@ setup-hooks =
[build_sphinx]
all_files = 1
-build-dir = docs/build
-source-dir = docs/
+build-dir = doc/build
+source-dir = doc/