mirror of
https://github.com/avatao-content/baseimage-tutorial-framework
synced 2024-11-15 07:37:17 +00:00
56 lines
1.1 KiB
ReStructuredText
56 lines
1.1 KiB
ReStructuredText
.. baseimage-tutorial-framework documentation master file, created by
|
|
sphinx-quickstart on Fri Jun 1 14:29:07 2018.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Welcome to baseimage-tutorial-framework's documentation!
|
|
========================================================
|
|
|
|
Foundations
|
|
-----------
|
|
|
|
This part covers the soil which the framework is based on and stuff you will need to develop your own challenges.
|
|
|
|
.. toctree::
|
|
:glob:
|
|
|
|
foundations/*
|
|
|
|
Networking
|
|
----------
|
|
|
|
You can use these to send messages to the frontend or the event handlers through TFWServer.
|
|
|
|
.. toctree::
|
|
:glob:
|
|
|
|
networking/*
|
|
|
|
Components
|
|
----------
|
|
|
|
These are pre-written components for you to use, such as our IDE, terminal or console.
|
|
|
|
.. toctree::
|
|
:glob:
|
|
|
|
components/*
|
|
|
|
Utility
|
|
-------
|
|
|
|
These are useful decorators, mixins and helpers to make common dev tasks easier.
|
|
|
|
.. toctree::
|
|
:glob:
|
|
|
|
utility/*
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|