summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorClaudius "keldu" Holeksa <mail@keldu.de>2024-05-23 17:23:25 +0200
committerClaudius "keldu" Holeksa <mail@keldu.de>2024-05-23 17:23:25 +0200
commit8b5c1e6a6cd5536d9414262c42452f8655658728 (patch)
tree29bf1540f93e33c64f63dc58b9bc2a90738310f7 /docs/source
parenteedd47efb3255f55216125cd3cd2ebdad3b8c1b6 (diff)
Got the docs to be generated
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/_static/css/custom.css15
-rw-r--r--docs/source/conf.py30
-rw-r--r--docs/source/index.rst22
-rw-r--r--docs/source/manual/introduction.rst4
4 files changed, 71 insertions, 0 deletions
diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css
new file mode 100644
index 0000000..ba76c62
--- /dev/null
+++ b/docs/source/_static/css/custom.css
@@ -0,0 +1,15 @@
+: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/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..07c21ad
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,30 @@
+# 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/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..b994f13
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,22 @@
+.. 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 Gasp Example's documentation!
+========================================
+
+.. toctree::
+ :hidden:
+ :maxdepth: 2
+ :caption: Manual
+
+ manual/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
new file mode 100644
index 0000000..edf7742
--- /dev/null
+++ b/docs/source/manual/introduction.rst
@@ -0,0 +1,4 @@
+Introduction
+============
+
+This is an example intro.