diff options
| author | Alistair Coles <alistairncoles@gmail.com> | 2018-06-28 09:19:11 +0100 |
|---|---|---|
| committer | Alistair Coles <alistairncoles@gmail.com> | 2018-06-28 09:19:11 +0100 |
| commit | 108304ea69d2ecc2b1beae8e4ab3dedec9bce334 (patch) | |
| tree | e546fdb2968a940ef60a5b4d3d9181718c50cd55 /README.rst | |
| parent | 891861546d2342cacd13e417c4429b609d2d7a00 (diff) | |
| download | swift-108304ea69d2ecc2b1beae8e4ab3dedec9bce334.tar.gz | |
Improve README doc building instructions
Dependencies must be installed before the docs
can successfully be built with sphinx.
Change-Id: Idd896408ecf6d9afd37ae5701cdbc224b029fd2f
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/README.rst b/README.rst index 4b4de03af..c66a9c453 100644 --- a/README.rst +++ b/README.rst @@ -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 |