From: Christian Weiske <cweiske@cweiske.de>
Date: Wed, 1 Jul 2015 18:14:02 +0000 (+0200)
Subject: use rst2html5 to render docs
X-Git-Tag: v1.1~24
X-Git-Url: https://git.cweiske.de/ouya-store-api.git/commitdiff_plain/c6dd0441a3548eaf362405454fcf7eee9617c271

use rst2html5 to render docs
---

diff --git a/README.rst b/README.rst
index 0954cf1..e910d59 100644
--- a/README.rst
+++ b/README.rst
@@ -2,7 +2,7 @@
 OUYA store API documentation
 ****************************
 
-This is an attempt to document the API used by OUYA gaming devices to
+This is an attempt to document the API used by OUYA gaming consoles to
 speak with ``devs.ouya.tv``.
 
 .. contents::
@@ -66,3 +66,16 @@ Home page
 =========
 A rendered version of this documentation is available at
 http://cweiske.de/ouya-store-api-docs.htm
+
+
+
+Building
+========
+You need to install ``rst2html5`` before::
+
+    $ pip install rst2html5-tools
+
+Rendering the docs is done via a build script::
+
+    $ ./build.sh
+
diff --git a/build.sh b/build.sh
index 5854090..3c4854e 100755
--- a/build.sh
+++ b/build.sh
@@ -1,2 +1,10 @@
 #!/bin/sh
-rst2html README.rst ouya-store-api-docs.htm
+#rst2html README.rst ouya-store-api-docs.htm
+rst2html5\
+ --bootstrap-css\
+ --stylesheet-path=styles.css --embed-stylesheet\
+ README.rst ouya-store-api-docs.htm
+
+# workaround for https://github.com/marianoguerra/rst2html5/issues/70
+sed -i 's#<title></title>#<title>OUYA store API documentation</title>#'\
+ ouya-store-api-docs.htm
diff --git a/styles.css b/styles.css
new file mode 100644
index 0000000..2860ace
--- /dev/null
+++ b/styles.css
@@ -0,0 +1,25 @@
+body {
+    margin: 3ex 15%;
+    font-family: helvetica;
+    color: #222;
+}
+
+header code, #contents code {
+    font-size: inherit;
+    border: none;
+    background-color: transparent;
+    color: inherit;
+}
+h1 {
+    text-align: center;
+    margin-bottom: 2ex;
+}
+h2 {
+    margin-top: 3ex;
+    padding-top: 1ex;
+    border-top: 1px solid grey;
+}
+
+dd {
+    margin-left: 3ex;
+}
\ No newline at end of file