mrtoth/baseimage-tutorial-framework
1
0
Fork 0
mirror of https://github.com/avatao-content/baseimage-tutorial-framework synced 2025-11-04 11:32:55 +00:00
Code Issues Releases Wiki Activity

Add sphinx API documentation

Browse Source
This commit is contained in:
Kristóf Tóth
2018-06-01 16:20:20 +02:00
parent c0fb28c46c
commit e80cce00f3
16 changed files with 381 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/source/foundations/eventhandlers.rst Normal file
View File

@@ -0,0 +1,12 @@
Event handler base classes
--------------------------
Subclass these to create your cusom event handlers.
.. automodule:: tfw
.. autoclass:: EventHandlerBase
:members:
.. autoclass:: TriggeredEventHandler
:members:

12
docs/source/foundations/fsms.rst Normal file
View File

@@ -0,0 +1,12 @@
FSM base classes
----------------
Subclass these to create an FSM that fits your tutorial/challenge.
.. automodule:: tfw
.. autoclass:: FSMBase
:members:
.. autoclass:: LinearFSM
:members:

7
docs/source/foundations/tfwserver.rst Normal file
View File

@@ -0,0 +1,7 @@
TFWServer
---------
.. automodule:: tfw.networking
.. autoclass:: TFWServer
:members: