Build script

diff --git a/.gitignore b/.gitignore
index 7bd2dc8ce037d583f55e66bc008086a5c8269dd0..764c0b5352783bf07a283631eed92c7cac42dfb2 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,2 @@
+/gamestick-api-docs.htm
 /README.html

diff --git a/README.rst b/README.rst
index b91590172293fdf5d6ee5ae5ee620a70300ce4e8..515592a1b32675722f25ad93bcb8fe89f3a945ba 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -21,3 +21,43 @@ gaming console.
 .. include:: api/l2.gamestickservices.net/api-rest-wallet-payment-topupwallet-init-transaction-do.rst
 .. include:: api/update.gamestickservices.net/check.php.rst
 .. include:: api/www.playjam.com/bundles-system-meta.json.rst
+
+
+=====
+About
+=====
+This documentation has been written by Christian Weiske,
[email protected].
+
+Last update: ##UPDATE##
+
+
+License
+=======
+It is licensed under the GNU Free Documentation License.
+
+
+Source code
+===========
+The documentation sources are available at
+https://git.cweiske.de/playjam-gamestick-api-docs.git
+and mirrored at
+https://codeberg.org/cweiske/playjam-gamestick-api-docs
+
+
+Home page
+=========
+A rendered version of this documentation is available at
+http://cweiske.de/gamestick-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
new file mode 100755 (executable)
index 0000000..9397245
--- /dev/null
+++ b/build.sh
@@ -0,0 +1,8 @@
+#!/bin/sh
+rst2html5\
+ --stylesheet-inline=styles.css\
+ --title="PlayJam GameStick server API documentation"\
+ README.rst gamestick-api-docs.htm
+
+# add current date to rendered docs
+sed -i "s/##UPDATE##/`date -Is`/" gamestick-api-docs.htm

diff --git a/styles.css b/styles.css
new file mode 100644 (file)
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