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
2012-06-08 12:14:46 -07:00 · 2012-06-08 12:14:46 -07:00 · f1a8e0c54f
commit f1a8e0c54f
parent f9d38741dd
45 changed files with 13 additions and 8 deletions
--- 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
--- 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

--- 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
--- a/docs/Makefile
+++ b/docs/Makefile
--- a/docs/source/_static/.gitignore
+++ b/docs/source/_static/.gitignore
--- a/docs/source/_static/basic.css
+++ b/docs/source/_static/basic.css
--- a/docs/source/_static/default.css
+++ b/docs/source/_static/default.css
--- a/docs/source/_static/header-line.gif
+++ b/docs/source/_static/header-line.gif
--- a/docs/source/_static/header_bg.jpg
+++ b/docs/source/_static/header_bg.jpg
--- a/docs/source/_static/jquery.tweet.js
+++ b/docs/source/_static/jquery.tweet.js
--- a/docs/source/_static/openstack_logo.png
+++ b/docs/source/_static/openstack_logo.png
--- a/docs/source/_static/tweaks.css
+++ b/docs/source/_static/tweaks.css
--- a/docs/source/_templates/.placeholder
+++ b/docs/source/_templates/.placeholder
--- a/docs/source/_theme/layout.html
+++ b/docs/source/_theme/layout.html
--- a/docs/source/_theme/nature.css_t
+++ b/docs/source/_theme/nature.css_t
--- a/docs/source/_theme/theme.conf
+++ b/docs/source/_theme/theme.conf
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
--- a/docs/source/contributing.rst
+++ b/docs/source/contributing.rst
--- a/docs/source/faq.rst
+++ b/docs/source/faq.rst
--- a/docs/source/glossary.rst
+++ b/docs/source/glossary.rst
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
--- a/docs/source/intro.rst
+++ b/docs/source/intro.rst
--- a/docs/source/quickstart.rst
+++ b/docs/source/quickstart.rst
--- a/docs/source/ref/context_processors.rst
+++ b/docs/source/ref/context_processors.rst
--- a/docs/source/ref/decorators.rst
+++ b/docs/source/ref/decorators.rst
--- a/docs/source/ref/exceptions.rst
+++ b/docs/source/ref/exceptions.rst
--- a/docs/source/ref/forms.rst
+++ b/docs/source/ref/forms.rst
--- a/docs/source/ref/horizon.rst
+++ b/docs/source/ref/horizon.rst
--- a/docs/source/ref/middleware.rst
+++ b/docs/source/ref/middleware.rst
--- a/docs/source/ref/run_tests.rst
+++ b/docs/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
 ==============================
--- a/docs/source/ref/tables.rst
+++ b/docs/source/ref/tables.rst
--- a/docs/source/ref/tabs.rst
+++ b/docs/source/ref/tabs.rst
--- a/docs/source/ref/test.rst
+++ b/docs/source/ref/test.rst
--- a/docs/source/ref/users.rst
+++ b/docs/source/ref/users.rst
--- a/docs/source/ref/views.rst
+++ b/docs/source/ref/views.rst
--- a/docs/source/ref/workflows.rst
+++ b/docs/source/ref/workflows.rst
--- a/docs/source/releases/2012_1.rst
+++ b/docs/source/releases/2012_1.rst
--- a/docs/source/testing.rst
+++ b/docs/source/testing.rst
--- a/docs/source/topics/customizing.rst
+++ b/docs/source/topics/customizing.rst
--- a/docs/source/topics/deployment.rst
+++ b/docs/source/topics/deployment.rst
--- a/docs/source/topics/tables.rst
+++ b/docs/source/topics/tables.rst
--- a/docs/source/topics/testing.rst
+++ b/docs/source/topics/testing.rst
--- a/docs/source/topics/tutorial.rst
+++ b/docs/source/topics/tutorial.rst
--- 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."
 }

--- 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