From 97229e0c843381edda0e37c7bc04841db5ef17b2 Mon Sep 17 00:00:00 2001
From: Luke Shumaker <lukeshu@sbcglobal.net>
Date: Sun, 11 Dec 2016 15:19:54 -0500
Subject: include the README in the API docs

---
 README                  | 73 ++++++++++++++++++++++++-------------------------
 jarmonbuild/commands.py |  3 +-
 2 files changed, 38 insertions(+), 38 deletions(-)

diff --git a/README b/README
index 0835701..2da9744 100644
--- a/README
+++ b/README
@@ -1,48 +1,47 @@
-Jarmon 10.7
-
-
-What is this?
-=============
-jarmon.js contains various wrappers and convenience fuctions for working with
-the javascriptRRD, Flot and RRD files generated by eg Collectd.
-Additionally, there is a fully working example which demonstrates how to use
-jarmon.js and how to integrate it with other javascript components - such as
-calendar date pickers etc.
+jarmon.js contains various wrappers and convenience fuctions for
+working with the [javascriptRRD][], [Flot][] and RRD files generated
+by eg [Collectd][].  Additionally, there is a fully working example
+which demonstrates how to use jarmon.js and how to integrate it with
+other javascript components - such as calendar date pickers etc.
 
+[javascriptRRD]: http://javascriptrrd.sourceforge.net/
+[Flot]: http://www.flotcharts.org/
+[Collectd]: https://collectd.org/
 
 Debian / Ubuntu Quick Start
 ===========================
-There is a demo html page in the docs/examples folder.
-To get this demo working, you will need to serve that page from a
-local webserver and serve the folder that contains your RRD files.
-
-This demo is designed to work with the RRD files generated by
-<a href="http://collectd.org/">Collectd</a>.
-
-# Install and configure collectd (enable the rrd plugin)
-$ aptitude install collectd
 
-# Create a project folder and check out the code
-$ mkdir -p ~/Projects/Jarmon
-$ cd ~/Projects/Jarmon
-$ bzr branch lp:~richardw/jarmon/trunk
-$ cd trunk
-
-# Link to the collectd rrd folder
-$ ln -s /var/lib/collectd/rrd/localhost docs/examples/data
-
-# Start a local webserver - here we use Twisted, but there are other web server
-# config examples in docs/
-$ aptitude install twisted
-$ twistd -n web --port 8080 --path .
-
-$ firefox http://localhost:8080/docs/examples/index.html
+There is a demo html page in the `docs/examples` folder.  To get this
+demo working, you will need to serve that page from a local webserver
+and serve the folder that contains your RRD files.
 
+This demo is designed to work with the RRD files generated by
+[Collectd][].
+
+    # Install and configure collectd (enable the rrd plugin)
+    $ aptitude install collectd
+    
+    # Create a project folder and check out the code
+    $ mkdir -p ~/Projects/Jarmon
+    $ cd ~/Projects/Jarmon
+    $ bzr branch lp:~richardw/jarmon/trunk
+    $ cd trunk
+    
+    # Link to the collectd rrd folder
+    $ ln -s /var/lib/collectd/rrd/localhost docs/examples/data
+    
+    # Start a local webserver - here we use Python 2's built-in web
+    # server, but there are other web server config examples in docs/
+	$ python2 -m SimpleHTTPServer 8080
+    
+    $ firefox http://localhost:8080/docs/examples/index.html
 
 Next Steps
 ==========
+
 Examine:
- * docs/examples/index.html
- * docs/examples/jarmon_example_recipes.js
+ * `docs/examples/index.html`
+ * `docs/examples/jarmon_example_recipes.js`
 
-...for examples of how to use jarmon.js then add your own chart recipes.
+...for examples of how to use jarmon.js then add your own chart
+recipes.
diff --git a/jarmonbuild/commands.py b/jarmonbuild/commands.py
index 5623bbb..edb29ae 100644
--- a/jarmonbuild/commands.py
+++ b/jarmonbuild/commands.py
@@ -80,9 +80,10 @@ class BuildApidocsCommand(BuildCommand):
         check_call((
             'jsdoc',
             '-c', os.path.join(workingbranch_dir, 'jarmonbuild', 'jsdoc.json'),
+            '-r', os.path.join(workingbranch_dir, 'README'),
             '-d', apidocs_dir,
             os.path.join(workingbranch_dir, 'jarmon'),
-        ), stdout=PIPE, stderr=PIPE,)
+        ),)
 
 
 class BuildReleaseCommand(BuildCommand):
-- 
cgit v1.2.3