readthedocs

Author: Lillecarl

.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt

README.md

@@ -1,5 +1,7 @@
 # nixkube / nix + kube / nix-csi / nix-nri
 
+[![Documentation Status](https://readthedocs.org/projects/nixkube/badge/?version=latest)](https://nixkube.readthedocs.io/en/latest/?badge=latest)
+
 Mount /nix into Kubernetes pods using the CSI ephemeral volumes or NRI(Node Resource Interface). Volumes
 share lifetime with Pods and are embedded into the Podspec.
 
@@ -108,6 +110,8 @@ Examples:
 * [multi-system example](https://github.com/Lillecarl/hetzkube/blob/4ed76ec77bfb104d1c2307b1ba178efa61dd34e2/kubenix/modules/cheapam.nix#L113)
 * [single-system ci example(s)](https://github.com/Lillecarl/nix-csi/blob/3179e5f8383e760bbef313300a224e44f18722c7/kubenix/ci/default.nix)
 
+[Documentation](https://nixkube.readthedocs.io/)
+
 ---
 
 *This project is made possible by*

docs/conf.py

@@ -0,0 +1,25 @@
+project = "nixkube"
+copyright = "2025, Carl Andersson"
+author = "Carl Andersson"
+
+extensions = [
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.intersphinx",
+]
+
+myst_enable_extensions = [
+    "colon_fence",
+    "deflist",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+html_theme = "furo"
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+}

docs/index.md

@@ -0,0 +1,7 @@
+# nixkube
+
+```{toctree}
+:maxdepth: 2
+:caption: Contents
+
+```

docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx
+myst-parser
+furo