Improve README doc building instructions

Code Issues Proposed changes

Dependencies must be installed before the docs
can successfully be built with sphinx.
Change-Id: Idd896408ecf6d9afd37ae5701cdbc224b029fd2f

This commit is contained in:

Alistair Coles

2018年06月28日 09:19:11 +01:00

parent 891861546d

commit 108304ea69

1 changed files with 7 additions and 4 deletions

@@ -27,10 +27,13 @@ in the AUTHORS file.

Docs

----

To build documentation install sphinx (``pip install sphinx``), run

``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

commit and available online at

To build documentation run::

pip install -r requirements.txt -r doc/requirements.txt

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 commit and available online at

https://docs.openstack.org/swift/latest/.

For Developers