Generate ChipDeviceCtrl API doc on build

Author: cecille

docs/testing/GenerateChipDeviceCtrlDoc.sh docs/GenerateChipDeviceCtrlDoc.sh

@@ -14,13 +14,17 @@
 # limitations under the License.
 #
 
-SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
+if [[ $# -ne 1 ]]; then
+  echo 'usage: GenerateChipDeviceCtrlDoc.sh build_directory'
+  exit 1
+fi
 
 pydoc-markdown -m chip.ChipDeviceCtrl '{
     renderer: {
       type: markdown,
       descriptive_class_title: false,
       render_toc: true,
+      render_toc_title: "ChipDeviceCtrl.py API",
       insert_header_anchors: true
     }
-  }' >"$SCRIPT_DIR"/ChipDeviceCtrlAPI.md
+  }' >"$1"/ChipDeviceCtrlAPI.md

docs/Makefile

@@ -7,6 +7,7 @@ SPHINXOPTS    ?= -W -T --keep-going -c . -d _build/doctrees
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = _build/src
 BUILDDIR      = _build
+PYTHON_API_DIR= ${BUILDDIR}/testing
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -18,4 +19,6 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	mkdir -p "$(SOURCEDIR)"
+	mkdir -p "${PYTHON_API_DIR}"
+	./GenerateChipDeviceCtrlDoc.sh ${PYTHON_API_DIR}
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/requirements.txt

@@ -4,3 +4,4 @@ sphinx-book-theme
 myst-parser
 breathe>=4.34
 pydata-sphinx-theme==0.14.4
+pydoc-markdown>=4.8.2