diff options
| author | Dolph Mathews <dolph.mathews@gmail.com> | 2011-10-26 10:54:41 -0500 |
|---|---|---|
| committer | Dolph Mathews <dolph.mathews@gmail.com> | 2011-10-26 11:05:04 -0500 |
| commit | 6fc3e76f09e3de595d4cace909c874b48eead9a5 (patch) | |
| tree | 9a7ce5bfb12a1dc7c2c3d3faeeb36fe0da3cd3d0 | |
| parent | cf803ba266438338947e080332ba680209cab786 (diff) | |
Removed contributor doc build info from project README (bug #843056)
Change-Id: I4a427284ebdaa104a89435945bbe88f3bf4d6299
| -rw-r--r-- | README.md | 12 | ||||
| -rw-r--r-- | doc/README.rst | 16 |
2 files changed, 13 insertions, 15 deletions
@@ -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: diff --git a/doc/README.rst b/doc/README.rst index 5e81a613..4f033508 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -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/ |