summaryrefslogtreecommitdiff
path: root/doc/core/index.rst
diff options
context:
space:
mode:
authorDanny Holman <dholman@gymli.org>2024-10-25 01:49:29 -0500
committerDanny Holman <dholman@gymli.org>2024-10-25 01:49:29 -0500
commite38d94416f705aa4ddd32e1c51199b45b58d6093 (patch)
tree88f19d0f17aed3ff5004d28d7c4fa49e28ad08b8 /doc/core/index.rst
parent28e27060274591fe13d5a1a226216fb01141e2f7 (diff)
doc: add introductory documentation files
Add documentation files that act as the starting points for the rest of the documentation and introduce a beginner to Rune. Signed-off-by: Danny Holman <dholman@gymli.org>
Diffstat (limited to 'doc/core/index.rst')
-rw-r--r--doc/core/index.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/core/index.rst b/doc/core/index.rst
new file mode 100644
index 0000000..f0d8710
--- /dev/null
+++ b/doc/core/index.rst
@@ -0,0 +1,37 @@
+Core API reference
+==================
+
+Initialization
+--------------
+
+.. doxygenfile:: init.h
+
+Error handling
+--------------
+
+.. doxygenfile:: abort.h
+
+Data structures
+---------------
+
+.. doxygenfile:: list.h
+
+Logging
+-------
+
+.. doxygenfile:: logging.h
+
+Memory allocation
+-----------------
+
+.. doxygenfile:: alloc.h
+
+Mod interface
+-------------
+
+.. doxygenfile:: mod.h
+
+Multithreading
+--------------
+
+.. doxygenfile:: thread.h