doc/index.rst
author Edouard Tisserant <edouard.tisserant@gmail.com>
Mon, 27 Mar 2023 10:12:20 +0200
branchwxPython4
changeset 3748 a811e1ff718a
parent 811 66a8812457d6
child 3925 1d383b4c0a23
permissions -rw-r--r--
Tests: Add time emulation feature for tests with BEREMIZ_TEST_CYCLES CFLAG.

Adding BEREMIZ_TEST_CYCLES=1000 in a project's CFLAGS will:
- run 1000 cycles with no pause
- emulate time flowing normaly for PLC code
- exit PLC thread

This allows:
- testing standard library blocks that deal with time without having to wait
- unit testing and code coverage with POUs that uses time
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     1
.. Beremiz documentation master file
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     2
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     3
Beremiz's documentation
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     4
=======================
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     5
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     6
Contents:
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     7
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     8
.. toctree::
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     9
   :maxdepth: 2
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    10
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    11
   overview
811
66a8812457d6 Added subdirectories in documentation, with more deoctree items to test. Enabled i18n in sphinx doc, tested with a small french translation
Edouard Tisserant
parents: 810
diff changeset
    12
   manual/index
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    13
   standards
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    14