summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorClaudius "keldu" Holeksa <mail@keldu.de>2026-11-07 17:49:12 +0100
committerClaudius "keldu" Holeksa <mail@keldu.de>2026-11-07 17:49:12 +0100
commitbeed9c20da5fbacf8626e2d4b747bb84ae7f6d93 (patch)
tree3835bcdc4180b7e2c68a51f8b1e1c759f298bd1d /docs/source
parent25b8bc7c4bbd914f27d745bea07e0bc66c9841b1 (diff)
downloadforstio-forstio-beed9c20da5fbacf8626e2d4b747bb84ae7f6d93.tar.gz
Moved docs around
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/_static/css/custom.css15
-rw-r--r--docs/source/async/introduction.rst6
-rw-r--r--docs/source/codec/introduction.rst12
-rw-r--r--docs/source/conf.py30
-rw-r--r--docs/source/core/introduction.rst5
-rw-r--r--docs/source/index.rst36
-rw-r--r--docs/source/manual/introduction.rst14
7 files changed, 0 insertions, 118 deletions
diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css
deleted file mode 100644
index ba76c62..0000000
--- a/docs/source/_static/css/custom.css
+++ /dev/null
@@ -1,15 +0,0 @@
-:root {
- --content-background-color: #fff5e1;
- --navbar-background-color: #263547;
- --navbar-heading-color: #eeeeee;
-}
-
-.wy-nav-side {
- background: var(--navbar-background-color);
-}
-
-.classref-section-separator {
- border-color: var(--navbar-heading-color);
- border-top-width: 3px;
- margin: 36px 0;
-}
diff --git a/docs/source/async/introduction.rst b/docs/source/async/introduction.rst
deleted file mode 100644
index 7a6c05f..0000000
--- a/docs/source/async/introduction.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-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/codec/introduction.rst b/docs/source/codec/introduction.rst
deleted file mode 100644
index 8cda2ac..0000000
--- a/docs/source/codec/introduction.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-Introduction
-============
-
-The codec module provides basic functionality and is in fact a vital component for almost all other modules.
-It's the module which provides the separation of logical structure and encoding of data.
-
-I am not aware of any programming languages which provide compile time separation of those concerns.
-For the less powerful compile time reflection capabilities there's limited support in some languages.
-C++26, regular C++ and Rust with minor additional hints etc come to mind. But this is only on native data.
-
-The separation enables treating data purely declaretively instead of imperative actions when moving it across encoding boundaries.
-A regular file has the structure
diff --git a/docs/source/conf.py b/docs/source/conf.py
deleted file mode 100644
index 07c21ad..0000000
--- a/docs/source/conf.py
+++ /dev/null
@@ -1,30 +0,0 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
-project = 'forstio docs'
-copyright = '2024, Claudius "keldu" Holeksa'
-author = 'Claudius "keldu" Holeksa'
-release = '2024'
-
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
-extensions = [
- 'sphinx_rtd_theme'
-]
-
-templates_path = ['_templates']
-exclude_patterns = []
-
-
-
-# -- Options for HTML output -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
-html_theme = 'sphinx_rtd_theme'
-html_static_path = ['_static']
diff --git a/docs/source/core/introduction.rst b/docs/source/core/introduction.rst
deleted file mode 100644
index 1b70070..0000000
--- a/docs/source/core/introduction.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-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
deleted file mode 100644
index 600797b..0000000
--- a/docs/source/index.rst
+++ /dev/null
@@ -1,36 +0,0 @@
-.. Gasp Example documentation master file, created by
- sphinx-quickstart on Tue Aug 22 16:01:56 2023.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
-Welcome to forstio's documentation!
-===================================
-
-.. toctree::
- :hidden:
- :maxdepth: 2
- :caption: Manual
-
- manual/introduction
-
-.. toctree::
- :hidden:
- :maxdepth: 2
- :caption: Core
-
- core/introduction
-
-.. toctree::
- :hidden:
- :maxdepth: 2
- :caption: Async
-
- async/introduction
-
-.. toctree::
- :hidden:
- :maxdepth: 2
- :caption: API Reference
-
- c_api/index
- cpp_api/index
diff --git a/docs/source/manual/introduction.rst b/docs/source/manual/introduction.rst
deleted file mode 100644
index 920741d..0000000
--- a/docs/source/manual/introduction.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-Introduction
-============
-
-Forstio is a modular library focused on providing many convenience functions
-I find useful in a style I find easy to use.
-
-It is mostly an asynchronous, network and codec library. Due to the approach to
-networking it is also applicable to be used in acceleration contexts.
-Due to the same approach it's also possible to use it for language binding
-generation.
-
-You don't have to use everything and the modular nature of the library attempts to separate all those concerns as much as possible.
-A drawback of this is that I simplify everything through the nix package manager which you probably don't use.
-I'm open to suggestions allowing this modular structure while not making it harder for me.