diff options
| author | Clark Boylan <clark.boylan@gmail.com> | 2012-06-11 14:37:02 -0700 |
|---|---|---|
| committer | Clark Boylan <clark.boylan@gmail.com> | 2012-06-11 14:37:48 -0700 |
| commit | 77e5ce57fd0a5c912ac1c270cb94ac43bb637389 (patch) | |
| tree | 87819d66bdbe90c6bc8c22d56fc05b90c61ea3ac /README.rst | |
| parent | 64f685ad635a78ef4e1cb237652425c818219532 (diff) | |
| download | python-openstackclient-77e5ce57fd0a5c912ac1c270cb94ac43bb637389.tar.gz | |
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
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -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 |