Initial commit adding the sphinx build system and a bit of content

Author: RedNicStone

.github/workflows/documentation.yaml

@@ -0,0 +1,24 @@
+name: Docs
+on: [push, pull_request, workflow_dispatch]
+permissions:
+  contents: write
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme
+      - name: Sphinx build
+        run: |
+          sphinx-build doc _build
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true

Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

conf.py

@@ -0,0 +1,77 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'libosmio'
+copyright = '2023, RedNicStone'
+author = 'RedNicStone'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_book_theme'
+#html_logo = "_static/logo-wide.svg"
+html_title = "libosmio documentation"
+html_copy_source = True
+#html_favicon = "_static/logo-square.svg"
+html_last_updated_fmt = ""
+
+
+html_sidebars = {
+    "reference/blog/*": [
+        "navbar-logo.html",
+        "search-field.html",
+        "postcard.html",
+        "recentposts.html",
+        "tagcloud.html",
+        "categories.html",
+        "archives.html",
+        "sbt-sidebar-nav.html",
+    ]
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+html_css_files = ["custom.css"]
+
+html_theme_options = {
+    "repository_url": "https://github.com/RedNicStone/libosmio",
+    "use_repository_button": True,
+}

content/getting_started/api_architecture.rst

@@ -0,0 +1,32 @@
+
+libosmio's API design
+=====================
+
+This page was created to help new users understand how libosmio works.
+It will give you a good idea of how the API works, as well as some insight in how API calls are resolved internally.
+
+The design of the osmio ecosystem has been heavily inspired by the Vulkan graphics API at almost every place.
+While knowledge of the Vulkan API may help you understand how osmio's API is structured, it is certainly not required.
+
+Language compliance
+-------------------
+
+While libosmio's implementations are not restricted to a specific language, the API has been made compliant with C99.
+Even though earlier iterations were designed for C++ specifically, C99 has been chosen for wider compiler support on embedded devices.
+
+.. note::
+    Whether you use C++, C or any other C-like language in your project, you will be able to use libosmio.
+
+Library handles
+---------------
+
+Osmio uses opaque handles in many of its API functions.
+These are to be treated like any other pointer, so you can copy and move them as much as you like.
+Lifetime of a libosmio handle starts when it is created using a `osCreate...()` function and ends on `osDestroy...()`.
+
+.. important::
+    The raw data behind the handle is purposefully opaque as it is implementation-defined, so interfacing with it should be avoided outside of the library implementation.
+
+
+
+

index.rst

@@ -0,0 +1,21 @@
+
+libosmio Docs - Main branch
+===========================
+
+Welcome to the official documentation of the osmio project, a fast and universal library for low level communication.
+This document contains everything you need to know about libosmio, from how to open an interface to implementing your own ICDs.
+If you are just starting out with the osmio ecosystem, I recommend that you read the :ref:´introduction page <doc_about>´.
+
+.. toctree::
+   :maxdepth: 2
+
+   content/getting_started/api_architecture
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`