Add documentation generation

.gitlab-ci.yml

@@ -7,3 +7,26 @@ build:
     - meson build --buildtype release --werror
     - ninja -C build
     - cd build && meson test --no-rebuild
+
+docs:
+  stage: test
+  image: alpine:edge
+  before_script:
+    - apk add --no-cache python3 py3-sphinx make
+  script:
+    - cd docs
+    - make html
+
+pages:
+  stage: deploy
+  image: alpine:edge
+  before_script:
+    - apk add --no-cache python3 py3-sphinx make
+  script:
+    - cd docs
+    - make html
+    - mv _build/html ../public
+  artifacts:
+    paths:
+      - public
+  environment: production

docs/.gitignore

@@ -0,0 +1 @@
+/_build

docs/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)

docs/conf.py

@@ -0,0 +1,27 @@
+# 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 = 'libmegapixels'
+copyright = '2023, Martijn Braam'
+author = 'Martijn Braam'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,15 @@
+.. libmegapixels documentation master file, created by
+   sphinx-quickstart on Sun Dec  3 14:27:28 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+libmegapixels's documentation!
+==============================
+
+The libmegapixels library is an abstraction library between the V4L2 system in
+linux and the Megapixels GTK application. It helps with abstracting away the
+media graph interface in Linux for ARM platforms with cameras.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents: