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

4
.gitignore vendored
View File

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

View File

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

View File

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

View File

Before

Width:  |  Height:  |  Size: 48 B

After

Width:  |  Height:  |  Size: 48 B

View File

Before

Width:  |  Height:  |  Size: 3.7 KiB

After

Width:  |  Height:  |  Size: 3.7 KiB

View File

Before

Width:  |  Height:  |  Size: 3.6 KiB

After

Width:  |  Height:  |  Size: 3.6 KiB

View File

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

View File

@ -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."
}

View File

@ -1,3 +1,8 @@
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source
[nosetests]
verbosity=2
detailed-errors=1