From 5107602c0dc10f4546cf45e3a98a47d10970df1a Mon Sep 17 00:00:00 2001 From: Mike Spreitzer Date: Tue, 8 Mar 2016 22:43:07 -0500 Subject: [PATCH] Noted other requirements for generating documentation Generating the documentation requires the pip packages oslosphinx, reno, and reno[sphinx] and they are not in requirements.txt. Change-Id: I52156fc314a10ae5adc44bb88917461ca417df66 --- README.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.rst b/README.rst index 6186ccd6..ca9a0269 100644 --- a/README.rst +++ b/README.rst @@ -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*.