openstack
/
python-congressclient
Code Issues Proposed changes

Add missing makefile so HTML docs can be generated 

Also added instructions for generating the docs
to README.rst

Closes-bug: #1605678
Change-Id: I681a706e209308d29e1c04044ba7df702a8aea60
This commit is contained in:
aimee.ukasick 2016-07-22 11:49:25 -05:00
parent bc34c566ce
commit 77e875680c
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Makefile Normal file
View File

@ -0,0 +1,12 @@
TOPDIR=$(CURDIR)
SRCDIR=$(TOPDIR)/congressclient
all: docs
clean: rm -Rf $(TOPDIR)/doc/html/*
docs: $(TOPDIR)/doc/source/*.rst
sphinx-build -b html $(TOPDIR)/doc/source $(TOPDIR)/doc/html

9
README.rst
View File

@ -24,7 +24,16 @@ To execute CLI commands to standalone congress set with noauth:
$ cd python-congressclient $ cd python-congressclient
$ python setup.py install $ python setup.py install
* Read the HTML documentation::
Install python-sphinx and the oslosphinx extension if missing.
$ sudo pip install sphinx
$ sudo pip install oslosphinx
Build the docs
$ make docs
Open doc/html/index.html in a browser
* To execute CLI commands:: * To execute CLI commands::
$ cd python-congressclient $ cd python-congressclient