openstack
/
keystone
Code Issues Proposed changes

Removed contributor doc build info from project README (bug #843056) 

Change-Id: I4a427284ebdaa104a89435945bbe88f3bf4d6299
This commit is contained in:
Dolph Mathews 2011-10-26 10:54:41 -05:00
parent cf803ba266
commit 6fc3e76f09
2 changed files with 13 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -137,17 +137,7 @@ The output will go into the `target` folder (the source is in `src`). Output gen
### Editing and Building the Contributor Guide
This guide is written by contributors, for contributors.
The source is maintained in the `doc/source` folder using
[reStructuredText](http://docutils.sourceforge.net/rst.html)
and built by [Sphinx](http://sphinx.pocoo.org/) (a dependency from `tools/pip-requires`).
To rebuild the documentation from the root of the project:
$ python setup.py build_sphinx && open build/sphinx/html/index.html
Note: This will fail with an `invalid command` error if you do not have Sphinx installed.
Refer to `doc/README.rst`.
# Additional Information:

16
doc/README.rst
View File

@ -1,6 +1,14 @@
==========================
Building the Documentation
==========================
==================================
Building Contributor Documentation
==================================
This documentation is written by contributors, for contributors.
The source is maintained in the `doc/source` folder using
`reStructuredText`_ and built by `Sphinx`_ (a dependency from `tools/pip-requires`).
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx.pocoo.org/
Building automatically
======================
@ -16,7 +24,7 @@ Building manually
$ python doc/generate_autodoc_index.py
#. Run `sphinx_build` to produce the docs in HTML::
#. Use `sphinx-build` to produce the docs in HTML::
$ sphinx-build -b html doc/source/ build/sphinx/html/