updated docs to mkdocs, rtfd.io ready

Author: tibut

README.md

@@ -1 +1 @@
-docs/source/index.md
+docs/index.md

docs/source/index.md docs/index.mddocs/source/index.md renamed to docs/index.md

@@ -47,9 +47,11 @@ python-bitflow -script "testing/testing_file_in.txt -> my_processing()" -p my_pr
 Current version does not close properly in all cases. Use strg-C to exit.
 
 ## Library Examples
-bitflow-example.py: provides a short overview about how to setup a pipeline and initialize source,sink, and processing steps.
-download-data.py: downloads data from a given endpoint, filters samples
-provide-data.py: reads a file and provides this file via a listen port
+**bitflow-example.py**: provides a short overview about how to setup a pipeline and initialize source,sink, and processing steps.
+
+**download-data.py**: downloads data from a given endpoint, filters samples
+
+**provide-data.py**: reads a file and provides this file via a listen port
 
 ## TODO
 * support binary bitflow format

docs/requirments.txt

@@ -0,0 +1 @@
+mkdocs==1.0.4

docs/source/conf.py

@@ -0,0 +1,26 @@
+site_name: Python-Bitflow
+repo_url: https://github.com/bitflow-stream/python-bitflow
+site_author: mwallschlaeger
+site_description: Python Bitflow Documentation
+theme: readthedocs
+plugins:
+    - search
+markdown_extensions:
+    - sane_lists
+    - smarty
+    - toc:
+        permalink: True
+nav:
+    - Home:
+        - The Bitflow Project: "https://bitflow.readthedocs.io/en/latest/"
+        - Data Sources, Sinks and Format: "https://bitflow.readthedocs.io/en/latest/data-format/"
+        - Bitflow Script: "https://bitflow.readthedocs.io/projects/bitflow-antlr-grammars/en/latest/bitflow-script/"
+    - Implementations:
+        - go-bitflow: "https://bitflow.readthedocs.io/projects/go-bitflow/en/latest/"
+        - bitflow4j (Github): "https://github.com/bitflow-stream/bitflow4j"
+        - python-bitflow: "index.md"
+    - Related Projects:
+        - bitflow-collector: "https://bitflow.readthedocs.io/projects/go-bitflow-collector/en/latest/"
+        - bitflow-coordinator (Github): "https://github.com/bitflow-stream/bitflow-coordinator"
+        - bitflow-process-agent (Github): "https://github.com/bitflow-stream/bitflow-process-agent"
+