Documentation WIP

docs/Pipfile

@@ -10,4 +10,4 @@ sphinx = "*"
 sphinx-rtd-theme = "*"
 
 [requires]
-python_version = "3.7"
+python_version = "3.8"

docs/source/conf.py

@@ -48,7 +48,12 @@ exclude_patterns = []
 html_theme = "sphinx_rtd_theme"
 html_logo = "_static/logo.png"
 html_theme_options = {
-    'logo_only': True
+    'logo_only': True,
+    'collapse_navigation': False,
+    'navigation_depth': 4,
+    'includehidden': True,
+    'titles_only': False
+
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

docs/source/index.rst

@@ -2,14 +2,17 @@
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: TODO
 
-Quickstart Guide
-================
+   install
+   quickstart
 
-.. todo::
+.. toctree::
+   :maxdepth: 2
+   :caption: Tutorial
+
+   tutorial
 
-   Here an end to end tutorial (15-20 minutes)
 
 
 Indices and tables

docs/source/install.rst

@@ -0,0 +1,17 @@
+Installation
+============
+
+Precompiled Binaries
+--------------------
+
+1. Get a precompiled static binary for your system from our `releases section <https://github.com/BBVA/kapow/releases/latest>`_.
+
+2. Put it in your ``$PATH`` (Linux example):
+
+   .. code-block:: bash
+
+      sudo install kapow1.0.0-rc1_linux_amd64 /usr/bin/kapow
+
+.. todo::
+
+   Describe all the options available.

docs/source/quickstart.rst

@@ -0,0 +1,27 @@
+Quickstart Guide
+================
+
+
+Hello World! -- *Kapow!* style
+------------------------------
+
+In a shell, the traditional `Hello World!` program would be ``echo "Hello World!"``.
+Let's publish it through HTTP using *Kapow!*
+
+- First you need a *script file* with the route that will publish your command, lets's call the file ``greet.sh`` and should contain the following code:
+
+.. code-block:: bash
+
+    kapow route add /greet -c 'echo "Hello World!" | kapow set /response/body'
+
+- Start the *Kapow!* server with your script as an argument
+
+.. code-block:: bash
+
+    kapow server greet.sh
+
+- Finally check that all is working as intended:
+
+.. image:: _static/browser.png
+
+

docs/source/tutorial.rst

@@ -0,0 +1,28 @@
+
+.. todo::
+
+   Redo 
+
+Hello World! -- *Kapow!* style
+------------------------------
+
+In a shell, the traditional `Hello World!` program would be ``echo "Hello World!"``.
+Let's publish it through HTTP using *Kapow!*
+
+- First you need a *script file* with the route that will publish your command, lets's call the file ``greet.sh`` and should contain the following code:
+
+.. code-block:: bash
+
+    kapow route add /greet -c 'echo "Hello World!" | kapow set /response/body'
+
+- Start the *Kapow!* server with your script as an argument
+
+.. code-block:: bash
+
+    kapow server greet.sh
+
+- Finally check that all is working as intended:
+
+.. image:: _static/browser.png
+
+