diff --git a/docs/README.md b/docs/README.md index 6f962ed9..4fab7c9c 100644 --- 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. \ No newline at end of file diff --git a/docs/run_build_docs.sh b/docs/run_build_docs.sh new file mode 100755 index 00000000..861d3cf5 --- /dev/null +++ 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