Add build docs script

tenstorrent · Sep 16, 2024 · fdca2d8 · fdca2d8
1 parent 5042999
commit fdca2d8
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -6,8 +6,8 @@ TODO
 
 ## Build docs
 
-In order to build docs `TT_UMD_HOME` needs to be set to root of tt-umd project.
+In order to build docs environment variable `TT_UMD_HOME` needs to be set to root of tt-umd project.
 
-After that you can run [`build_docs.sh`](build_docs.sh)
+After that you can run [`run_build_docs.sh`](run_build_docs.sh)
 
 In `docs` directory you will find `doxygen_build` directory with multiple formats of the docs.
diff --git a/docs/run_build_docs.sh b/docs/run_build_docs.sh
@@ -0,0 +1,9 @@
+if [[ -z "$TT_UMD_HOME" ]]; then
+  echo "Must provide TT_UMD_HOME in environment" 1>&2
+  exit 1
+fi
+
+echo "Building tt-umd docs..."
+
+cd $TT_UMD_HOME
+doxygen Doxyfile