summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorClark Boylan <clark.boylan@gmail.com>2012-06-08 12:14:46 -0700
committerClark Boylan <clark.boylan@gmail.com>2012-06-12 11:41:04 -0700
commitf1a8e0c54ffa96b98c632e3fde5bb9be8345fde9 (patch)
treecae78eaf34abe4a1fd1980e2297d5100d2ee0858
parentf9d38741dd3033e57d0064d63ef2b55566cc0618 (diff)
downloadtuskar-ui-f1a8e0c54ffa96b98c632e3fde5bb9be8345fde9.tar.gz
Move docs to doc.
To better facilitate the building and publishing of sphinx documentation by Jenkins we are moving all openstack projects with sphinx documentation to a common doc tree structure. Documentation goes in project/doc and build results go in project/doc/build. Change-Id: Ic523a716e4113198b777d6dc3db8bb8a729e7696
-rw-r--r--.gitignore4
-rw-r--r--MANIFEST.in6
-rw-r--r--README.rst2
-rw-r--r--doc/Makefile (renamed from docs/Makefile)0
-rw-r--r--doc/source/_static/.gitignore (renamed from docs/source/_static/.gitignore)0
-rw-r--r--doc/source/_static/basic.css (renamed from docs/source/_static/basic.css)0
-rw-r--r--doc/source/_static/default.css (renamed from docs/source/_static/default.css)0
-rw-r--r--doc/source/_static/header-line.gif (renamed from docs/source/_static/header-line.gif)bin48 -> 48 bytes
-rw-r--r--doc/source/_static/header_bg.jpg (renamed from docs/source/_static/header_bg.jpg)bin3738 -> 3738 bytes
-rw-r--r--doc/source/_static/jquery.tweet.js (renamed from docs/source/_static/jquery.tweet.js)0
-rw-r--r--doc/source/_static/openstack_logo.png (renamed from docs/source/_static/openstack_logo.png)bin3670 -> 3670 bytes
-rw-r--r--doc/source/_static/tweaks.css (renamed from docs/source/_static/tweaks.css)0
-rw-r--r--doc/source/_templates/.placeholder (renamed from docs/source/_templates/.placeholder)0
-rw-r--r--doc/source/_theme/layout.html (renamed from docs/source/_theme/layout.html)0
-rw-r--r--doc/source/_theme/nature.css_t (renamed from docs/source/_theme/nature.css_t)0
-rw-r--r--doc/source/_theme/theme.conf (renamed from docs/source/_theme/theme.conf)0
-rw-r--r--doc/source/conf.py (renamed from docs/source/conf.py)0
-rw-r--r--doc/source/contributing.rst (renamed from docs/source/contributing.rst)0
-rw-r--r--doc/source/faq.rst (renamed from docs/source/faq.rst)0
-rw-r--r--doc/source/glossary.rst (renamed from docs/source/glossary.rst)0
-rw-r--r--doc/source/index.rst (renamed from docs/source/index.rst)0
-rw-r--r--doc/source/intro.rst (renamed from docs/source/intro.rst)0
-rw-r--r--doc/source/quickstart.rst (renamed from docs/source/quickstart.rst)0
-rw-r--r--doc/source/ref/context_processors.rst (renamed from docs/source/ref/context_processors.rst)0
-rw-r--r--doc/source/ref/decorators.rst (renamed from docs/source/ref/decorators.rst)0
-rw-r--r--doc/source/ref/exceptions.rst (renamed from docs/source/ref/exceptions.rst)0
-rw-r--r--doc/source/ref/forms.rst (renamed from docs/source/ref/forms.rst)0
-rw-r--r--doc/source/ref/horizon.rst (renamed from docs/source/ref/horizon.rst)0
-rw-r--r--doc/source/ref/middleware.rst (renamed from docs/source/ref/middleware.rst)0
-rw-r--r--doc/source/ref/run_tests.rst (renamed from docs/source/ref/run_tests.rst)2
-rw-r--r--doc/source/ref/tables.rst (renamed from docs/source/ref/tables.rst)0
-rw-r--r--doc/source/ref/tabs.rst (renamed from docs/source/ref/tabs.rst)0
-rw-r--r--doc/source/ref/test.rst (renamed from docs/source/ref/test.rst)0
-rw-r--r--doc/source/ref/users.rst (renamed from docs/source/ref/users.rst)0
-rw-r--r--doc/source/ref/views.rst (renamed from docs/source/ref/views.rst)0
-rw-r--r--doc/source/ref/workflows.rst (renamed from docs/source/ref/workflows.rst)0
-rw-r--r--doc/source/releases/2012_1.rst (renamed from docs/source/releases/2012_1.rst)0
-rw-r--r--doc/source/testing.rst (renamed from docs/source/testing.rst)0
-rw-r--r--doc/source/topics/customizing.rst (renamed from docs/source/topics/customizing.rst)0
-rw-r--r--doc/source/topics/deployment.rst (renamed from docs/source/topics/deployment.rst)0
-rw-r--r--doc/source/topics/tables.rst (renamed from docs/source/topics/tables.rst)0
-rw-r--r--doc/source/topics/testing.rst (renamed from docs/source/topics/testing.rst)0
-rw-r--r--doc/source/topics/tutorial.rst (renamed from docs/source/topics/tutorial.rst)0
-rwxr-xr-xrun_tests.sh2
-rw-r--r--setup.cfg5
45 files changed, 13 insertions, 8 deletions
diff --git a/.gitignore b/.gitignore
index 40caa430..3fedf1d0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,8 +12,8 @@ pylint.txt
reports
horizon.egg-info
openstack_dashboard/local/local_settings.py
-docs/build/
-docs/source/sourcecode
+doc/build/
+doc/source/sourcecode
/static/
.venv
.tox
diff --git a/MANIFEST.in b/MANIFEST.in
index 30b41ca2..56996a06 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,4 +1,4 @@
-recursive-include docs *.py *.rst *.css *.js *.html *.conf *.jpg *.gif *.png *.css_t
+recursive-include doc *.py *.rst *.css *.js *.html *.conf *.jpg *.gif *.png *.css_t
recursive-include horizon *.html *.css *.js *.csv *.template *.tmpl *.mo *.po
recursive-include openstack_dashboard *.html *.js *.css *.less *.csv *.template *.mo *.po *.example *.eot *.svg *.ttf *.woff *.png *.gif *.ico *.wsgi
recursive-include tools *.py *.sh
@@ -10,8 +10,8 @@ include Makefile
include manage.py
include README.rst
include run_tests.sh
-include docs/Makefile
-include docs/source/_templates/.placeholder
+include doc/Makefile
+include doc/source/_templates/.placeholder
include tools/pip-requires
include tools/test-requires
diff --git a/README.rst b/README.rst
index ed1c4dda..edda2b77 100644
--- a/README.rst
+++ b/README.rst
@@ -106,7 +106,7 @@ Building Contributor Documentation
This documentation is written by contributors, for contributors.
-The source is maintained in the ``docs/source`` folder using
+The source is maintained in the ``doc/source`` folder using
`reStructuredText`_ and built by `Sphinx`_
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
diff --git a/docs/Makefile b/doc/Makefile
index 986ad3df..986ad3df 100644
--- a/docs/Makefile
+++ b/doc/Makefile
diff --git a/docs/source/_static/.gitignore b/doc/source/_static/.gitignore
index e69de29b..e69de29b 100644
--- a/docs/source/_static/.gitignore
+++ b/doc/source/_static/.gitignore
diff --git a/docs/source/_static/basic.css b/doc/source/_static/basic.css
index d909ce37..d909ce37 100644
--- a/docs/source/_static/basic.css
+++ b/doc/source/_static/basic.css
diff --git a/docs/source/_static/default.css b/doc/source/_static/default.css
index c8091ecb..c8091ecb 100644
--- a/docs/source/_static/default.css
+++ b/doc/source/_static/default.css
diff --git a/docs/source/_static/header-line.gif b/doc/source/_static/header-line.gif
index 3601730e..3601730e 100644
--- a/docs/source/_static/header-line.gif
+++ b/doc/source/_static/header-line.gif
Binary files differ
diff --git a/docs/source/_static/header_bg.jpg b/doc/source/_static/header_bg.jpg
index f788c41c..f788c41c 100644
--- a/docs/source/_static/header_bg.jpg
+++ b/doc/source/_static/header_bg.jpg
Binary files differ
diff --git a/docs/source/_static/jquery.tweet.js b/doc/source/_static/jquery.tweet.js
index 79bf0bdb..79bf0bdb 100644
--- a/docs/source/_static/jquery.tweet.js
+++ b/doc/source/_static/jquery.tweet.js
diff --git a/docs/source/_static/openstack_logo.png b/doc/source/_static/openstack_logo.png
index 146faec5..146faec5 100644
--- a/docs/source/_static/openstack_logo.png
+++ b/doc/source/_static/openstack_logo.png
Binary files differ
diff --git a/docs/source/_static/tweaks.css b/doc/source/_static/tweaks.css
index 8ed4c9db..8ed4c9db 100644
--- a/docs/source/_static/tweaks.css
+++ b/doc/source/_static/tweaks.css
diff --git a/docs/source/_templates/.placeholder b/doc/source/_templates/.placeholder
index e69de29b..e69de29b 100644
--- a/docs/source/_templates/.placeholder
+++ b/doc/source/_templates/.placeholder
diff --git a/docs/source/_theme/layout.html b/doc/source/_theme/layout.html
index 750b7822..750b7822 100644
--- a/docs/source/_theme/layout.html
+++ b/doc/source/_theme/layout.html
diff --git a/docs/source/_theme/nature.css_t b/doc/source/_theme/nature.css_t
index a98bd420..a98bd420 100644
--- a/docs/source/_theme/nature.css_t
+++ b/doc/source/_theme/nature.css_t
diff --git a/docs/source/_theme/theme.conf b/doc/source/_theme/theme.conf
index 1cc40044..1cc40044 100644
--- a/docs/source/_theme/theme.conf
+++ b/doc/source/_theme/theme.conf
diff --git a/docs/source/conf.py b/doc/source/conf.py
index 1fa2d706..1fa2d706 100644
--- a/docs/source/conf.py
+++ b/doc/source/conf.py
diff --git a/docs/source/contributing.rst b/doc/source/contributing.rst
index e884d854..e884d854 100644
--- a/docs/source/contributing.rst
+++ b/doc/source/contributing.rst
diff --git a/docs/source/faq.rst b/doc/source/faq.rst
index 26836ef6..26836ef6 100644
--- a/docs/source/faq.rst
+++ b/doc/source/faq.rst
diff --git a/docs/source/glossary.rst b/doc/source/glossary.rst
index 36bf635e..36bf635e 100644
--- a/docs/source/glossary.rst
+++ b/doc/source/glossary.rst
diff --git a/docs/source/index.rst b/doc/source/index.rst
index 111a1d31..111a1d31 100644
--- a/docs/source/index.rst
+++ b/doc/source/index.rst
diff --git a/docs/source/intro.rst b/doc/source/intro.rst
index a546ce99..a546ce99 100644
--- a/docs/source/intro.rst
+++ b/doc/source/intro.rst
diff --git a/docs/source/quickstart.rst b/doc/source/quickstart.rst
index c8c8644a..c8c8644a 100644
--- a/docs/source/quickstart.rst
+++ b/doc/source/quickstart.rst
diff --git a/docs/source/ref/context_processors.rst b/doc/source/ref/context_processors.rst
index b34c0109..b34c0109 100644
--- a/docs/source/ref/context_processors.rst
+++ b/doc/source/ref/context_processors.rst
diff --git a/docs/source/ref/decorators.rst b/doc/source/ref/decorators.rst
index 777afbe5..777afbe5 100644
--- a/docs/source/ref/decorators.rst
+++ b/doc/source/ref/decorators.rst
diff --git a/docs/source/ref/exceptions.rst b/doc/source/ref/exceptions.rst
index 4151f18f..4151f18f 100644
--- a/docs/source/ref/exceptions.rst
+++ b/doc/source/ref/exceptions.rst
diff --git a/docs/source/ref/forms.rst b/doc/source/ref/forms.rst
index 9b30cb8e..9b30cb8e 100644
--- a/docs/source/ref/forms.rst
+++ b/doc/source/ref/forms.rst
diff --git a/docs/source/ref/horizon.rst b/doc/source/ref/horizon.rst
index cc4b2d70..cc4b2d70 100644
--- a/docs/source/ref/horizon.rst
+++ b/doc/source/ref/horizon.rst
diff --git a/docs/source/ref/middleware.rst b/doc/source/ref/middleware.rst
index fcca5ff0..fcca5ff0 100644
--- a/docs/source/ref/middleware.rst
+++ b/doc/source/ref/middleware.rst
diff --git a/docs/source/ref/run_tests.rst b/doc/source/ref/run_tests.rst
index 579d7d48..b74aa1c5 100644
--- a/docs/source/ref/run_tests.rst
+++ b/doc/source/ref/run_tests.rst
@@ -147,7 +147,7 @@ You can build Horizon's documentation automatically by running::
./run_tests.sh --docs
-The output is stored in ``./docs/build/html/``.
+The output is stored in ``./doc/build/html/``.
Updating the translation files
==============================
diff --git a/docs/source/ref/tables.rst b/doc/source/ref/tables.rst
index 4b74d5e3..4b74d5e3 100644
--- a/docs/source/ref/tables.rst
+++ b/doc/source/ref/tables.rst
diff --git a/docs/source/ref/tabs.rst b/doc/source/ref/tabs.rst
index 807385ca..807385ca 100644
--- a/docs/source/ref/tabs.rst
+++ b/doc/source/ref/tabs.rst
diff --git a/docs/source/ref/test.rst b/doc/source/ref/test.rst
index ccf3f046..ccf3f046 100644
--- a/docs/source/ref/test.rst
+++ b/doc/source/ref/test.rst
diff --git a/docs/source/ref/users.rst b/doc/source/ref/users.rst
index 857358d1..857358d1 100644
--- a/docs/source/ref/users.rst
+++ b/doc/source/ref/users.rst
diff --git a/docs/source/ref/views.rst b/doc/source/ref/views.rst
index 970609ca..970609ca 100644
--- a/docs/source/ref/views.rst
+++ b/doc/source/ref/views.rst
diff --git a/docs/source/ref/workflows.rst b/doc/source/ref/workflows.rst
index c4077667..c4077667 100644
--- a/docs/source/ref/workflows.rst
+++ b/doc/source/ref/workflows.rst
diff --git a/docs/source/releases/2012_1.rst b/doc/source/releases/2012_1.rst
index e024bf41..e024bf41 100644
--- a/docs/source/releases/2012_1.rst
+++ b/doc/source/releases/2012_1.rst
diff --git a/docs/source/testing.rst b/doc/source/testing.rst
index b3b15038..b3b15038 100644
--- a/docs/source/testing.rst
+++ b/doc/source/testing.rst
diff --git a/docs/source/topics/customizing.rst b/doc/source/topics/customizing.rst
index 040319a2..040319a2 100644
--- a/docs/source/topics/customizing.rst
+++ b/doc/source/topics/customizing.rst
diff --git a/docs/source/topics/deployment.rst b/doc/source/topics/deployment.rst
index 16f4e105..16f4e105 100644
--- a/docs/source/topics/deployment.rst
+++ b/doc/source/topics/deployment.rst
diff --git a/docs/source/topics/tables.rst b/doc/source/topics/tables.rst
index b59dffb2..b59dffb2 100644
--- a/docs/source/topics/tables.rst
+++ b/doc/source/topics/tables.rst
diff --git a/docs/source/topics/testing.rst b/doc/source/topics/testing.rst
index 5c36ac82..5c36ac82 100644
--- a/docs/source/topics/testing.rst
+++ b/doc/source/topics/testing.rst
diff --git a/docs/source/topics/tutorial.rst b/doc/source/topics/tutorial.rst
index 1a6f48da..1a6f48da 100644
--- a/docs/source/topics/tutorial.rst
+++ b/doc/source/topics/tutorial.rst
diff --git a/run_tests.sh b/run_tests.sh
index 2995c21d..103a5654 100755
--- a/run_tests.sh
+++ b/run_tests.sh
@@ -141,7 +141,7 @@ function run_pep8 {
function run_sphinx {
echo "Building sphinx..."
export DJANGO_SETTINGS_MODULE=openstack_dashboard.settings
- ${command_wrapper} sphinx-build -b html docs/source docs/build/html
+ ${command_wrapper} sphinx-build -b html doc/source doc/build/html
echo "Build complete."
}
diff --git a/setup.cfg b/setup.cfg
index c4c71f1e..79034b3c 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,3 +1,8 @@
+[build_sphinx]
+all_files = 1
+build-dir = doc/build
+source-dir = doc/source
+
[nosetests]
verbosity=2
detailed-errors=1