diff options
author | Claudius 'keldu' Holeksa <mail@keldu.de> | 2024-08-20 10:02:57 +0200 |
---|---|---|
committer | Claudius 'keldu' Holeksa <mail@keldu.de> | 2024-08-20 10:02:57 +0200 |
commit | f0bc36c49adee797f9b89b41b6e12f6a2137b499 (patch) | |
tree | 1e005d788e368cf59fa98b994c95911e4731f389 | |
parent | 43c21269d8c614929ff0bff8383c36018fa1bb8e (diff) |
Adding more modules
-rw-r--r-- | docs/source/async/introduction.rst | 6 | ||||
-rw-r--r-- | docs/source/core/introduction.rst | 4 | ||||
-rw-r--r-- | docs/source/index.rst | 7 |
3 files changed, 15 insertions, 2 deletions
diff --git a/docs/source/async/introduction.rst b/docs/source/async/introduction.rst new file mode 100644 index 0000000..7a6c05f --- /dev/null +++ b/docs/source/async/introduction.rst @@ -0,0 +1,6 @@ +Introduction +============ + +The async module provides async functionality. +It introduces a basic event loop, which have to be activated and bound to a local thread through the wait scope class. +On a thread with an active event loop we can create async call graphs which automatically resolve the item moving through this graph. diff --git a/docs/source/core/introduction.rst b/docs/source/core/introduction.rst index 1a51e4d..1b70070 100644 --- a/docs/source/core/introduction.rst +++ b/docs/source/core/introduction.rst @@ -1,5 +1,5 @@ -Intro -===== +Introduction +============ The core module represents the most essential parts of this code base. This module provides basic functionality in regards to memory control, error functionalities and other minor things. diff --git a/docs/source/index.rst b/docs/source/index.rst index 7de2907..600797b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -23,6 +23,13 @@ Welcome to forstio's documentation! .. toctree:: :hidden: :maxdepth: 2 + :caption: Async + + async/introduction + +.. toctree:: + :hidden: + :maxdepth: 2 :caption: API Reference c_api/index |