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/source and build results go in project/doc/build.

Change-Id: I925e687254bac9e06c2c520f4fc35a083e21c4ca
This commit is contained in:
Clark Boylan 2012-06-11 14:37:02 -07:00
parent 64f685ad63
commit 77e5ce57fd
6 changed files with 6 additions and 6 deletions

View File

@ -1,5 +1,5 @@
include AUTHORS include AUTHORS
include LICENSE include LICENSE
include README.rst include README.rst
recursive-include docs * recursive-include doc *
recursive-include tests * recursive-include tests *

View File

@ -101,7 +101,7 @@ Building Contributor Documentation
This documentation is written by contributors, for contributors. 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`_ and built by `Sphinx`_
.. _reStructuredText: http://docutils.sourceforge.net/rst.html .. _reStructuredText: http://docutils.sourceforge.net/rst.html
@ -115,7 +115,7 @@ The source is maintained in the ``docs/source`` folder using
$ export DJANGO_SETTINGS_MODULE=local.local_settings $ export DJANGO_SETTINGS_MODULE=local.local_settings
$ python doc/generate_autodoc_index.py $ python doc/generate_autodoc_index.py
$ sphinx-build -b html docs/source build/sphinx/html $ sphinx-build -b html doc/source build/sphinx/html
Results are in the `build/sphinx/html` directory Results are in the `build/sphinx/html` directory

View File

@ -7,9 +7,9 @@ verbosity=2
detailed-errors=1 detailed-errors=1
[build_sphinx] [build_sphinx]
source-dir = docs/ source-dir = doc/source
build-dir = docs/_build build-dir = doc/build
all_files = 1 all_files = 1
[upload_sphinx] [upload_sphinx]
upload-dir = docs/_build/html upload-dir = doc/build/html