readthedocs: pre generate kas-container docs

The kas-container documentation needs manual pre-processing before the sphinx build can run. As the readthedocs build works differently, we need to manually call the pre-processing. Signed-off-by: Felix Moessbauer <[email protected]> [Jan: update base build os, add podman as dependency] Signed-off-by: Jan Kiszka <[email protected]>
siemens · Sep 30, 2024 · 2ad8df2 · 2ad8df2
1 parent f537669
commit 2ad8df2
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -1,6 +1,6 @@
 # kas - setup tool for bitbake based projects
 #
-# Copyright (c) Siemens AG, 2021
+# Copyright (c) Siemens AG, 2021-2024
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -23,11 +23,16 @@
 version: 2
 
 build:
-  os: ubuntu-20.04
+  os: ubuntu-24.04
   tools:
-    python: "3.9"
+    python: "3.12"
   apt_packages:
     - python3-newt
+    - make
+    - podman
+  jobs:
+    pre_build:
+      - cd docs && make kas-container-usage && cd ..
 
 python:
   install:

diff --git a/docs/Makefile b/docs/Makefile
@@ -156,6 +156,7 @@ text:
 
 kas-container-usage:
 	@echo Generate kas-container usage documentation
+	@mkdir -p $(BUILDDIR)
 	@../kas-container --help | ../scripts/kas-container-usage-to-rst.sh | awk '/KAS-COMMANDS/ {exit} {print}' \
 	    > $(BUILDDIR)/kas-container-usage-synopsis.inc
 	@../kas-container --help | ../scripts/kas-container-usage-to-rst.sh | awk '/KAS-COMMANDS/ {found=1} found' \