linse/frappy
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve doc.

Browse Source 
Change-Id: I0b25fd1c645a47084fb7fda1bbb7d41a2d10dcbb
This commit is contained in:
Alexander Lenz
2017-09-11 17:18:01 +02:00
parent cf3fabfa0f
commit 77b01404d9
56 changed files with 52 additions and 1297 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/playground/server/configuration.rst Normal file
View File

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

11
doc/source/playground/server/index.rst Normal file
View File

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

6
doc/source/playground/server/modules.rst Normal file
View File

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

6
doc/source/playground/server/protocol/encoding/demo_v2.rst Normal file
View File

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

6
doc/source/playground/server/protocol/encoding/demo_v3.rst Normal file
View File

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

6
doc/source/playground/server/protocol/encoding/demo_v4.rst Normal file
View File

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

6
doc/source/playground/server/protocol/encoding/demo_v5.rst Normal file
View File

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

11
doc/source/playground/server/protocol/encoding/index.rst Normal file
View File

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

7
doc/source/playground/server/protocol/framing/demo.rst Normal file
View File

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

6
doc/source/playground/server/protocol/framing/eol.rst Normal file
View File

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

11
doc/source/playground/server/protocol/framing/index.rst Normal file
View File

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

6
doc/source/playground/server/protocol/framing/null.rst Normal file
View File

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

6
doc/source/playground/server/protocol/framing/rle.rst Normal file
View File

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

10
doc/source/playground/server/protocol/index.rst Normal file
View File

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

9
doc/source/playground/server/protocol/interface/index.rst Normal file
View File

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

6
doc/source/playground/server/protocol/interface/tcp.rst Normal file
View File

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

6
doc/source/playground/server/protocol/interface/zmq.rst Normal file
View File

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

21
doc/source/playground/server/starting.rst Normal file
View File

@ -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