Improve doc.

Change-Id: I0b25fd1c645a47084fb7fda1bbb7d41a2d10dcbb

doc/source/playground/client/index.rst

@@ -0,0 +1,6 @@
+Client documentation
+====================
+
+.. toctree::
+   :maxdepth: 2
+

doc/source/playground/facility/demo/cryo.rst

@@ -0,0 +1,6 @@
+Demo cryostat
+=============
+
+.. automodule:: secop_demo.cryo
+    :members:
+

doc/source/playground/facility/demo/index.rst

@@ -0,0 +1,12 @@
+Demo
+====
+
+Specific sample environments
+----------------------------
+
+.. toctree::
+   :maxdepth: 3
+
+   cryo
+   test
+

doc/source/playground/facility/demo/test.rst

@@ -0,0 +1,6 @@
+Test devices
+=============
+
+.. automodule:: secop_demo.test
+    :members:
+

doc/source/playground/facility/ess/epics.rst

@@ -0,0 +1,6 @@
+EPICS modules
+=============
+
+.. automodule:: secop_ess.epics
+    :members:
+

doc/source/playground/facility/ess/index.rst

@@ -0,0 +1,11 @@
+ESS
+===
+
+Frameworks
+----------
+
+.. toctree::
+   :maxdepth: 3
+
+   epics
+

doc/source/playground/facility/index.rst

@@ -0,0 +1,9 @@
+Facility specific functionalities
+=================================
+
+.. toctree::
+   :maxdepth: 3
+
+   demo/index
+   mlz/index
+   ess/index

doc/source/playground/facility/mlz/amagnet.rst

@@ -0,0 +1,6 @@
+ANTARES magnet (amagnet)
+========================
+
+.. automodule:: secop_mlz.amagnet
+    :members:
+

doc/source/playground/facility/mlz/entangle.rst

@@ -0,0 +1,6 @@
+Entangle
+========
+
+.. automodule:: secop_mlz.entangle
+    :members:
+

doc/source/playground/facility/mlz/index.rst

@@ -0,0 +1,20 @@
+MLZ
+===
+
+Frameworks
+----------
+
+.. toctree::
+   :maxdepth: 3
+
+   entangle
+
+
+Specific sample environments
+----------------------------
+
+.. toctree::
+   :maxdepth: 3
+
+   amagnet
+

doc/source/playground/framework/datatypes.rst

@@ -0,0 +1,6 @@
+Datatypes
+=========
+
+.. automodule:: secop.datatypes
+    :members:
+

doc/source/playground/framework/errors.rst

@@ -0,0 +1,6 @@
+Exception classes
+=================
+
+.. automodule:: secop.errors
+    :members:
+

doc/source/playground/framework/index.rst

@@ -0,0 +1,9 @@
+Framework documentation
+=======================
+
+.. toctree::
+   :maxdepth: 2
+
+   datatypes
+   errors
+

doc/source/playground/gui/index.rst

@@ -0,0 +1,6 @@
+Graphical user interface documentation
+======================================
+
+.. toctree::
+   :maxdepth: 2
+

doc/source/playground/index.rst

@@ -0,0 +1,13 @@
+Playground documentation
+========================
+
+.. toctree::
+   :maxdepth: 2
+
+   server/index
+   client/index
+   framework/index
+   gui/index
+   facility/index
+
+

doc/source/playground/server/configuration.rst

@@ -0,0 +1,3 @@
+Configuration
+=============
+

doc/source/playground/server/index.rst

@@ -0,0 +1,11 @@
+Server documentation
+====================
+
+.. toctree::
+   :maxdepth: 3
+
+   starting
+   configuration
+   modules
+   protocol/index
+

doc/source/playground/server/modules.rst

@@ -0,0 +1,6 @@
+Module base classes
+===================
+
+.. automodule:: secop.modules
+    :members:
+

doc/source/playground/server/protocol/encoding/demo_v2.rst

@@ -0,0 +1,6 @@
+Demo V2
+=======
+
+.. automodule:: secop.protocol.encoding.demo_v2
+    :members:
+

doc/source/playground/server/protocol/encoding/demo_v3.rst

@@ -0,0 +1,6 @@
+Demo V3
+=======
+
+.. automodule:: secop.protocol.encoding.demo_v2
+    :members:
+

doc/source/playground/server/protocol/encoding/demo_v4.rst

@@ -0,0 +1,6 @@
+Demo V4
+=======
+
+.. automodule:: secop.protocol.encoding.demo_v2
+    :members:
+

doc/source/playground/server/protocol/encoding/demo_v5.rst

@@ -0,0 +1,6 @@
+Demo V5
+=======
+
+.. automodule:: secop.protocol.encoding.demo_v2
+    :members:
+

doc/source/playground/server/protocol/encoding/index.rst

@@ -0,0 +1,11 @@
+Encodings
+=========
+
+.. toctree::
+   :maxdepth: 3
+
+   demo_v2
+   demo_v3
+   demo_v4
+   demo_v5
+

doc/source/playground/server/protocol/framing/demo.rst

@@ -0,0 +1,7 @@
+Demo
+====
+
+.. automodule:: secop.protocol.framing.demo
+    :members:
+
+

doc/source/playground/server/protocol/framing/eol.rst

@@ -0,0 +1,6 @@
+EOL
+===
+
+.. automodule:: secop.protocol.framing.eol
+    :members:
+

doc/source/playground/server/protocol/framing/index.rst

@@ -0,0 +1,11 @@
+Framings
+========
+
+.. toctree::
+   :maxdepth: 3
+
+   demo
+   eol
+   null
+   rle
+

doc/source/playground/server/protocol/framing/null.rst

@@ -0,0 +1,6 @@
+Null
+====
+
+.. automodule:: secop.protocol.framing.null
+    :members:
+

doc/source/playground/server/protocol/framing/rle.rst

@@ -0,0 +1,6 @@
+RLE
+===
+
+.. automodule:: secop.protocol.framing.rle
+    :members:
+

doc/source/playground/server/protocol/index.rst

@@ -0,0 +1,10 @@
+Different protocols
+===================
+
+.. toctree::
+   :maxdepth: 3
+
+   encoding/index
+   framing/index
+   interface/index
+

doc/source/playground/server/protocol/interface/index.rst

@@ -0,0 +1,9 @@
+Interfaces
+==========
+
+.. toctree::
+   :maxdepth: 3
+
+   tcp
+   zmq
+

doc/source/playground/server/protocol/interface/tcp.rst

@@ -0,0 +1,6 @@
+TCP
+===
+
+.. automodule:: secop.protocol.interface.tcp
+    :members:
+

doc/source/playground/server/protocol/interface/zmq.rst

@@ -0,0 +1,6 @@
+ZMQ
+===
+
+.. automodule:: secop.protocol.interface.zmq
+    :members:
+

doc/source/playground/server/starting.rst

@@ -0,0 +1,21 @@
+Starting
+========
+
+The SECoP server can be started via the ``bin/secop-server`` script.
+
+.. parsed-literal::
+
+    usage: secop-server [-h] [-v | -q] [-d] name
+
+    Manage a SECoP server
+
+    positional arguments:
+      name             Name of the instance. Uses etc/name.cfg for configuration
+
+    optional arguments:
+      -h, --help       show this help message and exit
+      -v, --verbose    Output lots of diagnostic information
+      -q, --quiet      suppress non-error messages
+      -d, --daemonize  Run as daemon
+
+