openstack
/
kuryr-libnetwork
Code Issues Proposed changes

Merge "Noted other requirements for generating documentation"

This commit is contained in:
Jenkins 2016-03-09 12:20:52 +00:00 committed by Gerrit Code Review
parent 98b2cece4b 5107602c0d
commit 04906e078b
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.rst
View File

@ -81,6 +81,11 @@ documentation. You can install Sphinx using pip.
$ pip install -U Sphinx
In addition to Sphinx you will also need the following requirements
(not covered by `requirements.txt`)::
$ pip install oslosphinx reno 'reno[sphinx]'
The source code of the documentation are under *doc*, you can generate the
html files using the following command. If the generation succeeds,a
*build/html* dir will be created under *doc*.