openstack/swift
Code Issues Proposed changes

Update doc building instructions in Development Guidelines

Browse Source 
Change-Id: Ifd2f468ad745d19ef474ae7503a8bd79d429fc1b
This commit is contained in:
Nguyen Hai 2018-07-02 17:22:03 +09:00
parent ec7d60ebd2
commit 4409da697f
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.rst
View File

@ -32,7 +32,7 @@ To build documentation run::
pip install -r requirements.txt -r doc/requirements.txt pip install -r requirements.txt -r doc/requirements.txt
sphinx-build -W -b html doc/source doc/build/html 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 after every commit and available online at
https://docs.openstack.org/swift/latest/. https://docs.openstack.org/swift/latest/.

10
doc/source/development_guidelines.rst
View File

@ -221,10 +221,14 @@ More specifically:
the sphinx specific markup can be found here: the sphinx specific markup can be found here:
http://sphinx.pocoo.org/markup/index.html http://sphinx.pocoo.org/markup/index.html
Installing Sphinx: To build documentation run::
#. Install sphinx (On Ubuntu: ``sudo apt-get install python-sphinx``) pip install -r requirements.txt -r doc/requirements.txt
#. ``python setup.py build_sphinx`` 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 Manpages