From 77e875680cfad6376d393ec51a5d1c5a78b00800 Mon Sep 17 00:00:00 2001 From: "aimee.ukasick" Date: Fri, 22 Jul 2016 11:49:25 -0500 Subject: [PATCH] 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 --- Makefile | 12 ++++++++++++ README.rst | 9 +++++++++ 2 files changed, 21 insertions(+) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..0924763 --- /dev/null +++ b/Makefile @@ -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 + + diff --git a/README.rst b/README.rst index 544782d..d381b47 100644 --- a/README.rst +++ b/README.rst @@ -24,7 +24,16 @@ To execute CLI commands to standalone congress set with noauth: $ cd python-congressclient $ 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:: $ cd python-congressclient