From 77e5ce57fd0a5c912ac1c270cb94ac43bb637389 Mon Sep 17 00:00:00 2001 From: Clark Boylan Date: Mon, 11 Jun 2012 14:37:02 -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/source and build results go in project/doc/build. Change-Id: I925e687254bac9e06c2c520f4fc35a083e21c4ca --- MANIFEST.in | 2 +- README.rst | 4 ++-- {docs => doc}/Makefile | 0 {docs => doc}/source/conf.py | 0 {docs => doc}/source/index.rst | 0 setup.cfg | 6 +++--- 6 files changed, 6 insertions(+), 6 deletions(-) rename {docs => doc}/Makefile (100%) rename {docs => doc}/source/conf.py (100%) rename {docs => doc}/source/index.rst (100%) diff --git a/MANIFEST.in b/MANIFEST.in index 67b025934d..fa21b6cf55 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,5 +1,5 @@ include AUTHORS include LICENSE include README.rst -recursive-include docs * +recursive-include doc * recursive-include tests * diff --git a/README.rst b/README.rst index 1f022a706c..a935ef8440 100644 --- a/README.rst +++ b/README.rst @@ -101,7 +101,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 @@ -115,7 +115,7 @@ The source is maintained in the ``docs/source`` folder using $ export DJANGO_SETTINGS_MODULE=local.local_settings $ 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 diff --git a/docs/Makefile b/doc/Makefile similarity index 100% rename from docs/Makefile rename to doc/Makefile 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/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/setup.cfg b/setup.cfg index 2388434fd1..27d2986511 100644 --- a/setup.cfg +++ b/setup.cfg @@ -7,9 +7,9 @@ verbosity=2 detailed-errors=1 [build_sphinx] -source-dir = docs/ -build-dir = docs/_build +source-dir = doc/source +build-dir = doc/build all_files = 1 [upload_sphinx] -upload-dir = docs/_build/html +upload-dir = doc/build/html