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
This commit is contained in:
parent
be0f75f5a7
commit
5107602c0d
@ -81,6 +81,11 @@ documentation. You can install Sphinx using pip.
|
|||||||
|
|
||||||
$ pip install -U Sphinx
|
$ 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
|
The source code of the documentation are under *doc*, you can generate the
|
||||||
html files using the following command. If the generation succeeds,a
|
html files using the following command. If the generation succeeds,a
|
||||||
*build/html* dir will be created under *doc*.
|
*build/html* dir will be created under *doc*.
|
||||||
|
Loading…
Reference in New Issue
Block a user