doc: wip

2d960e1f · Dimitris Lampridis · be6ba436 · 2d960e1f · 2d960e1f · 2d960e1f
Commit 2d960e1f authored Jul 05, 2019 by Dimitris Lampridis
13 changed files
--- a/doc/basic_concepts.rst
+++ b/doc/basic_concepts.rst
@@ -234,7 +234,8 @@ When an input :ref:`event` is received by a :ref:`Node`, WRTD tries to match it
   :alt: alternate text
   :figclass: align-center

-   RX path of a Rule. The red hexagons represent :ref:`Attributes <attribute>`.
+   Rule processing for incoming :ref:`Events <event>`. The red hexagons represent :ref:`Attributes
+   <attribute>`.

 Once an input :ref:`event` has been matched and all delays have been applied to it, it is forwarded
 to the next processing block that generates the preconfigured output :ref:`event`. This is depicted
@@ -246,7 +247,8 @@ in :numref:`fig-wrtd-rule-tx`.
   :alt: alternate text
   :figclass: align-center

-   TX path of a Rule. The red hexagons represent :ref:`Attributes <attribute>`.
+   Rule processing for outgoing :ref:`Events <event>`. The red hexagons represent :ref:`Attributes
+   <attribute>`.

 .. hint:: There are actually more :ref:`Attributes <attribute>` than the ones shown in
          :numref:`fig-wrtd-rule-rx` and :numref:`fig-wrtd-rule-tx`. Please refer to the
@@ -281,7 +283,7 @@ triggered, following the process depicted in :numref:`fig-wrtd-alarm`.
   :alt: alternate text
   :figclass: align-center

-   Anatomy of an Alarm
+   Alarm processing.

 .. hint:: There are actually more :ref:`Attributes <attribute>` than the ones shown in
          :numref:`fig-wrtd-alarm`. Please refer to the :ref:`api_attr` for the complete list,

--- a/doc/conf.py
+++ b/doc/conf.py
@@ -16,9 +16,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.append(os.path.abspath('../software/lib/python'))

 # -- General configuration ------------------------------------------------

@@ -33,12 +33,13 @@ extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.todo',
    'sphinx.ext.mathjax',
-    'sphinx.ext.viewcode',
+#    'sphinx.ext.viewcode',
    'sphinx.ext.graphviz',
    'sphinx.ext.coverage',
    'breathe',
 ]

+autodoc_member_order = 'bysource'

 # Add any paths that contain templates here, relative to this directory.
 # templates_path = ['_templates']

--- a/doc/graphics/wrtd_repcaps.drawio
+++ b/doc/graphics/wrtd_repcaps.drawio
--- a/doc/graphics/wrtd_rule_rx.png
+++ b/doc/graphics/wrtd_rule_rx.png
--- a/doc/graphics/wrtd_rule_tx.png
+++ b/doc/graphics/wrtd_rule_tx.png
--- a/doc/installation.rst
+++ b/doc/installation.rst
@@ -7,3 +7,7 @@ Installation
 .. todo::
   Decide on installation and document it

+.. _res_names:
+
+Resource Names
+==============
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
 docutils==0.14
-Sphinx==1.8.3
+Sphinx==1.8.5
 sphinx_rtd_theme
-breathe==4.10.0
+breathe==4.11.0
 recommonmark==0.5.0
+decorator==4.4.0
--- a/doc/usage.rst
+++ b/doc/usage.rst
@@ -14,6 +14,8 @@ WRTD Library
 Error Handling API
 ------------------

+.. _api_error_codes:
+
 Error Codes
 +++++++++++

@@ -39,6 +41,8 @@ Initialisation API
 Attribute Handling API
 ----------------------

+.. _api_attr_id:
+
 Attributes
 ++++++++++

@@ -105,6 +109,8 @@ Applications API

 Python Library
 ==============
+.. autoclass:: PyWrtd.PyWrtd
+   :members:

 .. _tools:


--- a/software/lib/Python/.gitignore
+++ b/software/lib/Python/.gitignore
--- a/software/lib/Python/Makefile
+++ b/software/lib/Python/Makefile
--- a/software/lib/Python/PyWrtd.py
+++ b/software/lib/Python/PyWrtd.py
--- a/software/lib/Python/README.md
+++ b/software/lib/Python/README.md
--- a/software/lib/Python/setup.py
+++ b/software/lib/Python/setup.py