diff --git a/README.rst b/README.rst index 77c039cbd5..6f47e8e01e 100644 --- a/README.rst +++ b/README.rst @@ -32,7 +32,7 @@ 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 +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/. diff --git a/doc/source/development_guidelines.rst b/doc/source/development_guidelines.rst index 8e39a417e8..d6cc90b558 100644 --- a/doc/source/development_guidelines.rst +++ b/doc/source/development_guidelines.rst @@ -221,10 +221,14 @@ More specifically: the sphinx specific markup can be found here: http://sphinx.pocoo.org/markup/index.html -Installing Sphinx: +To build documentation run:: -#. Install sphinx (On Ubuntu: ``sudo apt-get install python-sphinx``) -#. ``python setup.py build_sphinx`` + 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/. -------- Manpages