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

- fixed documentation hierarchy

Browse Source 
Change-Id: Ic61b10c393b1d5fa12d194a804c19f23a570c792
Reviewed-on: https://forge.frm2.tum.de/review/16708
Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
This commit is contained in:
zolliker 2017-11-15 11:36:41 +01:00
parent 8663501150
commit 4cf4ecb507
3 changed files with 11 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/protocol/index.rst
View File

@ -2,7 +2,7 @@ Protocol documentation
====================== ======================
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 1
secop_v2017-09-14 secop_v2017-09-14
issue_1 issue_1

2
doc/source/protocol/outdated.rst
View File

@ -2,7 +2,7 @@ Outdated documentation
====================== ======================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 0
messages messages
descprop descprop

24
doc/source/protocol/secop_v2017-09-14.rst
View File

@ -1,5 +1,5 @@
SECoP: Sample Environment Communication Protocol SECoP: Sample Environment Communication Protocol
================================================ ################################################
V2017-09-14 V2017-09-14
@ -180,8 +180,6 @@ Properties
*definition of properties to be rewitten, see* `SECoP issue 5`_ *definition of properties to be rewitten, see* `SECoP issue 5`_
.. _`SECoP issue 5`: SECoP_issues/issue_5.html
Definition: Properties Definition: Properties
Parameters have a value, live properties and descriptive properties. All properties have a predefined name and meaning. Parameters have a value, live properties and descriptive properties. All properties have a predefined name and meaning.
@ -401,8 +399,6 @@ In this example it is the equipment ID, but this is redundant, as
"equipment_id" is also a SEC node property. "equipment_id" is also a SEC node property.
See `SECoP Issue 2`_ (Equipment ID in Describing Message) See `SECoP Issue 2`_ (Equipment ID in Describing Message)
.. _`SECoP Issue 2`: SECoP_Issues/issue_2.html
Remark: Remark:
this reply might be a very long line, no line breaks are allowed in the this reply might be a very long line, no line breaks are allowed in the
JSON value. JSON value.
@ -624,11 +620,6 @@ synchronize the time.
See also `SECoP Issue 4`_ (Timeout), `SECoP Issue 6`_ (Keep Alive), See also `SECoP Issue 4`_ (Timeout), `SECoP Issue 6`_ (Keep Alive),
`SECoP Issue 3`_ (Timestamps) or `SECoP Issue 7`_ (Time Synchronization) `SECoP Issue 3`_ (Timestamps) or `SECoP Issue 7`_ (Time Synchronization)
.. _`SECoP Issue 3`: SECoP_Issues/issue_3.html
.. _`SECoP Issue 4`: SECoP_Issues/issue_4.html
.. _`SECoP Issue 6`: SECoP_Issues/issue_6.html
.. _`SECoP Issue 7`: SECoP_Issues/issue_7.html
Multiple Connections Multiple Connections
-------------------- --------------------
@ -711,8 +702,6 @@ communication of a SEC node.
- **timeout** (optional value in seconds, a SEC node should be able to respond within - **timeout** (optional value in seconds, a SEC node should be able to respond within
a time well below this value. Default: 3 sec, see `SECoP issue 4`_ ) a time well below this value. Default: 3 sec, see `SECoP issue 4`_ )
.. _`SECoP issue 4`: SECoP_issues/issue_4.html
Module Properties Module Properties
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
@ -732,9 +721,6 @@ Module Properties
- **meaning**, **importance** (*see* `SECoP issue 9`_) - **meaning**, **importance** (*see* `SECoP issue 9`_)
.. _`SECoP issue 8`: SECoP_issues/issue_8.html
.. _`SECoP issue 9`: SECoP_issues/issue_9.html
Parameter Properties Parameter Properties
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
@ -928,3 +914,11 @@ struct
| |
| might be null | might be null
.. _`SECoP Issue 2`: SECoP_Issues/issue_2.html
.. _`SECoP Issue 3`: SECoP_Issues/issue_3.html
.. _`SECoP Issue 4`: SECoP_Issues/issue_4.html
.. _`SECoP issue 5`: SECoP_issues/issue_5.html
.. _`SECoP Issue 6`: SECoP_Issues/issue_6.html
.. _`SECoP Issue 7`: SECoP_Issues/issue_7.html
.. _`SECoP issue 8`: SECoP_issues/issue_8.html
.. _`SECoP issue 9`: SECoP_issues/issue_9.html