doc: initial sphinx files.

Change-Id: I6943f2f39340cb6bad52996bbcf50710c0575b7b
2017-09-11 11:25:13 +02:00
parent 230bd9b9a6
commit cf3fabfa0f
53 changed files with 837 additions and 260 deletions
--- a/doc/srcdoc/source/playground/server/protocol/encoding/demo_v2.rst
+++ b/doc/srcdoc/source/playground/server/protocol/encoding/demo_v2.rst
@@ -0,0 +1,6 @@
+Demo V2
+=======
+
+.. automodule:: secop.protocol.encoding.demo_v2
+    :members:
+
--- a/doc/srcdoc/source/playground/server/protocol/encoding/demo_v3.rst
+++ b/doc/srcdoc/source/playground/server/protocol/encoding/demo_v3.rst
@@ -0,0 +1,6 @@
+Demo V3
+=======
+
+.. automodule:: secop.protocol.encoding.demo_v2
+    :members:
+
--- a/doc/srcdoc/source/playground/server/protocol/encoding/demo_v4.rst
+++ b/doc/srcdoc/source/playground/server/protocol/encoding/demo_v4.rst
@@ -0,0 +1,6 @@
+Demo V4
+=======
+
+.. automodule:: secop.protocol.encoding.demo_v2
+    :members:
+
--- a/doc/srcdoc/source/playground/server/protocol/encoding/demo_v5.rst
+++ b/doc/srcdoc/source/playground/server/protocol/encoding/demo_v5.rst
@@ -0,0 +1,6 @@
+Demo V5
+=======
+
+.. automodule:: secop.protocol.encoding.demo_v2
+    :members:
+
--- a/doc/srcdoc/source/playground/server/protocol/encoding/index.rst
+++ b/doc/srcdoc/source/playground/server/protocol/encoding/index.rst
@@ -0,0 +1,11 @@
+Encodings
+=========
+
+.. toctree::
+   :maxdepth: 3
+
+   demo_v2
+   demo_v3
+   demo_v4
+   demo_v5
+
--- a/doc/srcdoc/source/playground/server/protocol/framing/demo.rst
+++ b/doc/srcdoc/source/playground/server/protocol/framing/demo.rst
@@ -0,0 +1,7 @@
+Demo
+====
+
+.. automodule:: secop.protocol.framing.demo
+    :members:
+
+
--- a/doc/srcdoc/source/playground/server/protocol/framing/eol.rst
+++ b/doc/srcdoc/source/playground/server/protocol/framing/eol.rst
@@ -0,0 +1,6 @@
+EOL
+===
+
+.. automodule:: secop.protocol.framing.eol
+    :members:
+
--- a/doc/srcdoc/source/playground/server/protocol/framing/index.rst
+++ b/doc/srcdoc/source/playground/server/protocol/framing/index.rst
@@ -0,0 +1,11 @@
+Framings
+========
+
+.. toctree::
+   :maxdepth: 3
+
+   demo
+   eol
+   null
+   rle
+
--- a/doc/srcdoc/source/playground/server/protocol/framing/null.rst
+++ b/doc/srcdoc/source/playground/server/protocol/framing/null.rst
@@ -0,0 +1,6 @@
+Null
+====
+
+.. automodule:: secop.protocol.framing.null
+    :members:
+
--- a/doc/srcdoc/source/playground/server/protocol/framing/rle.rst
+++ b/doc/srcdoc/source/playground/server/protocol/framing/rle.rst
@@ -0,0 +1,6 @@
+RLE
+===
+
+.. automodule:: secop.protocol.framing.rle
+    :members:
+
--- a/doc/srcdoc/source/playground/server/protocol/index.rst
+++ b/doc/srcdoc/source/playground/server/protocol/index.rst
@@ -0,0 +1,10 @@
+Different protocols
+===================
+
+.. toctree::
+   :maxdepth: 3
+
+   encoding/index
+   framing/index
+   interface/index
+
--- a/doc/srcdoc/source/playground/server/protocol/interface/index.rst
+++ b/doc/srcdoc/source/playground/server/protocol/interface/index.rst
@@ -0,0 +1,9 @@
+Interfaces
+==========
+
+.. toctree::
+   :maxdepth: 3
+
+   tcp
+   zmq
+
--- a/doc/srcdoc/source/playground/server/protocol/interface/tcp.rst
+++ b/doc/srcdoc/source/playground/server/protocol/interface/tcp.rst
@@ -0,0 +1,6 @@
+TCP
+===
+
+.. automodule:: secop.protocol.interface.tcp
+    :members:
+
--- a/doc/srcdoc/source/playground/server/protocol/interface/zmq.rst
+++ b/doc/srcdoc/source/playground/server/protocol/interface/zmq.rst
@@ -0,0 +1,6 @@
+ZMQ
+===
+
+.. automodule:: secop.protocol.interface.zmq
+    :members:
+