Document packages

docs/.gitignore

@@ -5,4 +5,5 @@ src/README.md
 src/hosts.md
 src/modules.md
 src/options.md
+src/packages.md
 mdbook-admonish.css

docs/src/SUMMARY.md

@@ -7,3 +7,4 @@
 - [Hosts](./hosts.md)
 - [Modules](./modules.md)
 - [Options](./options.md)
+- [Packages](./packages.md)

packages/bookdb/default.nix

@@ -1,3 +1,4 @@
+# A database and web app to keep track of all my books.
 { poetry2nix, fetchFromGitHub, ... }:
 
 let

packages/bookmarks/default.nix

@@ -1,3 +1,4 @@
+# A database and web app to keep track of my bookmarks.
 { poetry2nix, fetchFromGitHub, ... }:
 
 let

packages/prometheus-awair-exporter/default.nix

@@ -1,3 +1,4 @@
+# A simple Awair exporter for Prometheus.
 { buildGoModule, fetchFromGitHub, ... }:
 
 buildGoModule rec {

packages/resolved/default.nix

@@ -1,3 +1,4 @@
+#  A simple DNS server for home networks.
 { rustPlatform, fetchFromGitHub, ... }:
 
 rustPlatform.buildRustPackage rec {

scripts/documentation.sh

@@ -104,6 +104,32 @@ for option in sorted(options.keys()):
     print("")
 EOF
 
+python3 - <<'EOF' > docs/src/packages.md
+import os
+
+print("# Packages")
+print("")
+
+packages = sorted([name for name in os.listdir("packages") if name not in [".", ".."]])
+for package in packages:
+    source_file = f"packages/{package}/default.nix"
+
+    print(f"## {package}")
+
+    has_doc = False
+    with open(source_file, "r") as f:
+        for line in f:
+            if line.startswith("#"):
+                has_doc = True
+                print(line[1:].strip())
+            else:
+                break
+    if not has_doc:
+        print("This package has no description.")
+    print(f"\n**Declared in:** [{source_file}](https://github.com/barrucadu/nixfiles/blob/master/{source_file})")
+    print("")
+EOF
+
 mdbook build docs
 mv docs/book _site