From 108304ea69d2ecc2b1beae8e4ab3dedec9bce334 Mon Sep 17 00:00:00 2001 From: Alistair Coles Date: Thu, 28 Jun 2018 09:19:11 +0100 Subject: Improve README doc building instructions Dependencies must be installed before the docs can successfully be built with sphinx. Change-Id: Idd896408ecf6d9afd37ae5701cdbc224b029fd2f --- README.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'README.rst') 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 -- cgit v1.2.1