summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2013-01-29 15:07:29 +0000
committerGerrit Code Review <review@openstack.org>2013-01-29 15:07:29 +0000
commit1e381ee6dbfd8a35a5a085c62847fd1c9458ddbf (patch)
treef5b471db60b71d63d220f99b95c8d56397b751f4
parent02da3afe4df65b8c469ceb430ca34dab83d6451c (diff)
parent3ef034694d5917251c44f6255d3342a506aa18ae (diff)
Merge "Readme: use 'doc' directory not 'docs'"
-rw-r--r--README.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index a06edbc5..c0b3e722 100644
--- a/README.rst
+++ b/README.rst
@@ -27,15 +27,15 @@ Please see the documentation under ``doc/source/`` for development setup
Building the Documentation
--------------------------
-The documentation is all generated with Sphinx from within the docs directory.
+The documentation is all generated with Sphinx from within the doc directory.
To generate the full set of HTML documentation::
- cd docs
+ cd doc
make autodoc
make html
make man
-the results are in the ``docs/build/html`` and ``docs/build/man`` directories
+the results are in the ``doc/build/html`` and ``doc/build/man`` directories
respectively.
@@ -218,4 +218,4 @@ then do what is effectively a 'Simple Match' style match against the creds.
Dependencies
----------------------------------
-Ensure an OpenSSL version of 1.0+ is installed. \ No newline at end of file
+Ensure an OpenSSL version of 1.0+ is installed.