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:
parent
64f685ad63
commit
77e5ce57fd
@ -1,5 +1,5 @@
|
||||
include AUTHORS
|
||||
include LICENSE
|
||||
include README.rst
|
||||
recursive-include docs *
|
||||
recursive-include doc *
|
||||
recursive-include tests *
|
||||
|
@ -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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user