From f1a8e0c54ffa96b98c632e3fde5bb9be8345fde9 Mon Sep 17 00:00:00 2001 From: Clark Boylan Date: Fri, 8 Jun 2012 12:14:46 -0700 Subject: [PATCH] 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 --- .gitignore | 4 ++-- MANIFEST.in | 6 +++--- README.rst | 2 +- {docs => doc}/Makefile | 0 {docs => doc}/source/_static/.gitignore | 0 {docs => doc}/source/_static/basic.css | 0 {docs => doc}/source/_static/default.css | 0 {docs => doc}/source/_static/header-line.gif | Bin {docs => doc}/source/_static/header_bg.jpg | Bin {docs => doc}/source/_static/jquery.tweet.js | 0 {docs => doc}/source/_static/openstack_logo.png | Bin {docs => doc}/source/_static/tweaks.css | 0 {docs => doc}/source/_templates/.placeholder | 0 {docs => doc}/source/_theme/layout.html | 0 {docs => doc}/source/_theme/nature.css_t | 0 {docs => doc}/source/_theme/theme.conf | 0 {docs => doc}/source/conf.py | 0 {docs => doc}/source/contributing.rst | 0 {docs => doc}/source/faq.rst | 0 {docs => doc}/source/glossary.rst | 0 {docs => doc}/source/index.rst | 0 {docs => doc}/source/intro.rst | 0 {docs => doc}/source/quickstart.rst | 0 {docs => doc}/source/ref/context_processors.rst | 0 {docs => doc}/source/ref/decorators.rst | 0 {docs => doc}/source/ref/exceptions.rst | 0 {docs => doc}/source/ref/forms.rst | 0 {docs => doc}/source/ref/horizon.rst | 0 {docs => doc}/source/ref/middleware.rst | 0 {docs => doc}/source/ref/run_tests.rst | 2 +- {docs => doc}/source/ref/tables.rst | 0 {docs => doc}/source/ref/tabs.rst | 0 {docs => doc}/source/ref/test.rst | 0 {docs => doc}/source/ref/users.rst | 0 {docs => doc}/source/ref/views.rst | 0 {docs => doc}/source/ref/workflows.rst | 0 {docs => doc}/source/releases/2012_1.rst | 0 {docs => doc}/source/testing.rst | 0 {docs => doc}/source/topics/customizing.rst | 0 {docs => doc}/source/topics/deployment.rst | 0 {docs => doc}/source/topics/tables.rst | 0 {docs => doc}/source/topics/testing.rst | 0 {docs => doc}/source/topics/tutorial.rst | 0 run_tests.sh | 2 +- setup.cfg | 5 +++++ 45 files changed, 13 insertions(+), 8 deletions(-) rename {docs => doc}/Makefile (100%) rename {docs => doc}/source/_static/.gitignore (100%) rename {docs => doc}/source/_static/basic.css (100%) rename {docs => doc}/source/_static/default.css (100%) rename {docs => doc}/source/_static/header-line.gif (100%) rename {docs => doc}/source/_static/header_bg.jpg (100%) rename {docs => doc}/source/_static/jquery.tweet.js (100%) rename {docs => doc}/source/_static/openstack_logo.png (100%) rename {docs => doc}/source/_static/tweaks.css (100%) rename {docs => doc}/source/_templates/.placeholder (100%) rename {docs => doc}/source/_theme/layout.html (100%) rename {docs => doc}/source/_theme/nature.css_t (100%) rename {docs => doc}/source/_theme/theme.conf (100%) rename {docs => doc}/source/conf.py (100%) rename {docs => doc}/source/contributing.rst (100%) rename {docs => doc}/source/faq.rst (100%) rename {docs => doc}/source/glossary.rst (100%) rename {docs => doc}/source/index.rst (100%) rename {docs => doc}/source/intro.rst (100%) rename {docs => doc}/source/quickstart.rst (100%) rename {docs => doc}/source/ref/context_processors.rst (100%) rename {docs => doc}/source/ref/decorators.rst (100%) rename {docs => doc}/source/ref/exceptions.rst (100%) rename {docs => doc}/source/ref/forms.rst (100%) rename {docs => doc}/source/ref/horizon.rst (100%) rename {docs => doc}/source/ref/middleware.rst (100%) rename {docs => doc}/source/ref/run_tests.rst (99%) rename {docs => doc}/source/ref/tables.rst (100%) rename {docs => doc}/source/ref/tabs.rst (100%) rename {docs => doc}/source/ref/test.rst (100%) rename {docs => doc}/source/ref/users.rst (100%) rename {docs => doc}/source/ref/views.rst (100%) rename {docs => doc}/source/ref/workflows.rst (100%) rename {docs => doc}/source/releases/2012_1.rst (100%) rename {docs => doc}/source/testing.rst (100%) rename {docs => doc}/source/topics/customizing.rst (100%) rename {docs => doc}/source/topics/deployment.rst (100%) rename {docs => doc}/source/topics/tables.rst (100%) rename {docs => doc}/source/topics/testing.rst (100%) rename {docs => doc}/source/topics/tutorial.rst (100%) diff --git a/.gitignore b/.gitignore index 40caa4307..3fedf1d0e 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 30b41ca20..56996a06d 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 ed1c4dda3..edda2b776 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 similarity index 100% rename from docs/Makefile rename to doc/Makefile diff --git a/docs/source/_static/.gitignore b/doc/source/_static/.gitignore similarity index 100% rename from docs/source/_static/.gitignore rename to doc/source/_static/.gitignore diff --git a/docs/source/_static/basic.css b/doc/source/_static/basic.css similarity index 100% rename from docs/source/_static/basic.css rename to doc/source/_static/basic.css diff --git a/docs/source/_static/default.css b/doc/source/_static/default.css similarity index 100% rename from docs/source/_static/default.css rename to doc/source/_static/default.css diff --git a/docs/source/_static/header-line.gif b/doc/source/_static/header-line.gif similarity index 100% rename from docs/source/_static/header-line.gif rename to doc/source/_static/header-line.gif diff --git a/docs/source/_static/header_bg.jpg b/doc/source/_static/header_bg.jpg similarity index 100% rename from docs/source/_static/header_bg.jpg rename to doc/source/_static/header_bg.jpg diff --git a/docs/source/_static/jquery.tweet.js b/doc/source/_static/jquery.tweet.js similarity index 100% rename from docs/source/_static/jquery.tweet.js rename to doc/source/_static/jquery.tweet.js diff --git a/docs/source/_static/openstack_logo.png b/doc/source/_static/openstack_logo.png similarity index 100% rename from docs/source/_static/openstack_logo.png rename to doc/source/_static/openstack_logo.png diff --git a/docs/source/_static/tweaks.css b/doc/source/_static/tweaks.css similarity index 100% rename from docs/source/_static/tweaks.css rename to doc/source/_static/tweaks.css diff --git a/docs/source/_templates/.placeholder b/doc/source/_templates/.placeholder similarity index 100% rename from docs/source/_templates/.placeholder rename to doc/source/_templates/.placeholder diff --git a/docs/source/_theme/layout.html b/doc/source/_theme/layout.html similarity index 100% rename from docs/source/_theme/layout.html rename to doc/source/_theme/layout.html diff --git a/docs/source/_theme/nature.css_t b/doc/source/_theme/nature.css_t similarity index 100% rename from docs/source/_theme/nature.css_t rename to doc/source/_theme/nature.css_t diff --git a/docs/source/_theme/theme.conf b/doc/source/_theme/theme.conf similarity index 100% rename from docs/source/_theme/theme.conf rename to doc/source/_theme/theme.conf 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/contributing.rst b/doc/source/contributing.rst similarity index 100% rename from docs/source/contributing.rst rename to doc/source/contributing.rst diff --git a/docs/source/faq.rst b/doc/source/faq.rst similarity index 100% rename from docs/source/faq.rst rename to doc/source/faq.rst diff --git a/docs/source/glossary.rst b/doc/source/glossary.rst similarity index 100% rename from docs/source/glossary.rst rename to doc/source/glossary.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/docs/source/intro.rst b/doc/source/intro.rst similarity index 100% rename from docs/source/intro.rst rename to doc/source/intro.rst diff --git a/docs/source/quickstart.rst b/doc/source/quickstart.rst similarity index 100% rename from docs/source/quickstart.rst rename to doc/source/quickstart.rst diff --git a/docs/source/ref/context_processors.rst b/doc/source/ref/context_processors.rst similarity index 100% rename from docs/source/ref/context_processors.rst rename to doc/source/ref/context_processors.rst diff --git a/docs/source/ref/decorators.rst b/doc/source/ref/decorators.rst similarity index 100% rename from docs/source/ref/decorators.rst rename to doc/source/ref/decorators.rst diff --git a/docs/source/ref/exceptions.rst b/doc/source/ref/exceptions.rst similarity index 100% rename from docs/source/ref/exceptions.rst rename to doc/source/ref/exceptions.rst diff --git a/docs/source/ref/forms.rst b/doc/source/ref/forms.rst similarity index 100% rename from docs/source/ref/forms.rst rename to doc/source/ref/forms.rst diff --git a/docs/source/ref/horizon.rst b/doc/source/ref/horizon.rst similarity index 100% rename from docs/source/ref/horizon.rst rename to doc/source/ref/horizon.rst diff --git a/docs/source/ref/middleware.rst b/doc/source/ref/middleware.rst similarity index 100% rename from docs/source/ref/middleware.rst rename to doc/source/ref/middleware.rst diff --git a/docs/source/ref/run_tests.rst b/doc/source/ref/run_tests.rst similarity index 99% rename from docs/source/ref/run_tests.rst rename to doc/source/ref/run_tests.rst index 579d7d48b..b74aa1c57 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 similarity index 100% rename from docs/source/ref/tables.rst rename to doc/source/ref/tables.rst diff --git a/docs/source/ref/tabs.rst b/doc/source/ref/tabs.rst similarity index 100% rename from docs/source/ref/tabs.rst rename to doc/source/ref/tabs.rst diff --git a/docs/source/ref/test.rst b/doc/source/ref/test.rst similarity index 100% rename from docs/source/ref/test.rst rename to doc/source/ref/test.rst diff --git a/docs/source/ref/users.rst b/doc/source/ref/users.rst similarity index 100% rename from docs/source/ref/users.rst rename to doc/source/ref/users.rst diff --git a/docs/source/ref/views.rst b/doc/source/ref/views.rst similarity index 100% rename from docs/source/ref/views.rst rename to doc/source/ref/views.rst diff --git a/docs/source/ref/workflows.rst b/doc/source/ref/workflows.rst similarity index 100% rename from docs/source/ref/workflows.rst rename to doc/source/ref/workflows.rst diff --git a/docs/source/releases/2012_1.rst b/doc/source/releases/2012_1.rst similarity index 100% rename from docs/source/releases/2012_1.rst rename to doc/source/releases/2012_1.rst diff --git a/docs/source/testing.rst b/doc/source/testing.rst similarity index 100% rename from docs/source/testing.rst rename to doc/source/testing.rst diff --git a/docs/source/topics/customizing.rst b/doc/source/topics/customizing.rst similarity index 100% rename from docs/source/topics/customizing.rst rename to doc/source/topics/customizing.rst diff --git a/docs/source/topics/deployment.rst b/doc/source/topics/deployment.rst similarity index 100% rename from docs/source/topics/deployment.rst rename to doc/source/topics/deployment.rst diff --git a/docs/source/topics/tables.rst b/doc/source/topics/tables.rst similarity index 100% rename from docs/source/topics/tables.rst rename to doc/source/topics/tables.rst diff --git a/docs/source/topics/testing.rst b/doc/source/topics/testing.rst similarity index 100% rename from docs/source/topics/testing.rst rename to doc/source/topics/testing.rst diff --git a/docs/source/topics/tutorial.rst b/doc/source/topics/tutorial.rst similarity index 100% rename from docs/source/topics/tutorial.rst rename to doc/source/topics/tutorial.rst diff --git a/run_tests.sh b/run_tests.sh index 2995c21d6..103a56547 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 c4c71f1e3..79034b3c6 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