Update README related to documentation building
New command is: sphinx-build -W -b html doc/source doc/build/html Change-Id: I185ae7d69093660ab558cf866ae36e45bf213975
This commit is contained in:
parent
4c2ef69d31
commit
891861546d
@ -28,7 +28,7 @@ Docs
|
|||||||
----
|
----
|
||||||
|
|
||||||
To build documentation install sphinx (``pip install sphinx``), run
|
To build documentation install sphinx (``pip install sphinx``), run
|
||||||
``python setup.py build_sphinx``, and then browse to
|
``sphinx-build -W -b html doc/source doc/build/html``, and then browse to
|
||||||
/doc/build/html/index.html. These docs are auto-generated after every
|
/doc/build/html/index.html. These docs are auto-generated after every
|
||||||
commit and available online at
|
commit and available online at
|
||||||
https://docs.openstack.org/swift/latest/.
|
https://docs.openstack.org/swift/latest/.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user