diff options
| author | Todd Willey <todd@ansolabs.com> | 2010-11-07 14:46:17 -0500 |
|---|---|---|
| committer | Todd Willey <todd@ansolabs.com> | 2010-11-07 14:46:17 -0500 |
| commit | a999c8de9e51da2beda13fdbb66dfb0bad42f250 (patch) | |
| tree | 70c1ee9ca7a7a451840a03be096c58ddb9fc354f /doc/README.rst | |
| parent | fa90bccfe96c608e114a2974ab15e4a52f798970 (diff) | |
| download | nova-a999c8de9e51da2beda13fdbb66dfb0bad42f250.tar.gz | |
back out stacked merge
Diffstat (limited to 'doc/README.rst')
| -rw-r--r-- | doc/README.rst | 33 |
1 files changed, 0 insertions, 33 deletions
diff --git a/doc/README.rst b/doc/README.rst deleted file mode 100644 index 565e8d5bf5..0000000000 --- a/doc/README.rst +++ /dev/null @@ -1,33 +0,0 @@ -================= -Building the docs -================= - -It is really easy. You'll need sphinx (the python one) and if you are using the virtualenv you'll need to install it in the virtualenv specifically so that it can load the nova modules. - - -Use `make` -========== - -Just type make:: - - % make - -Look in the Makefile for more targets. - - -Manually -======== - - 1. Generate the code.rst file so that Sphinx will pull in our docstrings:: - - % ./generate_autodoc_index.sh > source/code.rst - - 2. Run `sphinx_build`:: - - % sphinx-build -b html source build/html - - -The docs have been built -======================== - -Check out the `build` directory to find them. Yay! |