From 9b6791657bf8c3e3f738ffd4a931f7a48d6376a4 Mon Sep 17 00:00:00 2001 From: David Garske Date: Tue, 1 Jun 2021 09:42:59 -0700 Subject: [PATCH] Fixes to support "make dox". --- .gitignore | 3 +++ docs/generate_documentation.sh | 9 ++++++++- docs/include.am | 16 ++++++++++++---- 3 files changed, 23 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index dd8ab23..af20b3f 100644 --- a/.gitignore +++ b/.gitignore @@ -80,3 +80,6 @@ quote.blob keyblob.bin ecc_test_blob.raw rsa_test_blob.raw + +# Generated Documentation +docs/html diff --git a/docs/generate_documentation.sh b/docs/generate_documentation.sh index 7b0b19a..8f5675d 100755 --- a/docs/generate_documentation.sh +++ b/docs/generate_documentation.sh @@ -1,7 +1,14 @@ #!/bin/bash +CURRDIR=${PWD##*/} +if [ "$CURRDIR" != "docs" ]; then + echo "Please run from the ./docs directory" + exit 1 +fi + +# Run from ./docs echo "Generating html..." doxygen Doxyfile echo "Finished generating html..." -echo "To view the html files use a browser to open the index.html file located at doc/html/index.html" +echo "To view the html files use a browser to open the index.html file located at docs/html/index.html" diff --git a/docs/include.am b/docs/include.am index aefc5fb..12af863 100644 --- a/docs/include.am +++ b/docs/include.am @@ -2,7 +2,15 @@ # included from Top Level Makefile.am # All paths should be given relative to the root -EXTRA_DIST+= docs/README.md -EXTRA_DIST+= docs/SWTPM.md -EXTRA_DIST+= docs/WindowTBS.md -EXTRA_DIST+= docs/Doxyfile +dist_doc_DATA+= docs/README.md +dist_doc_DATA+= docs/SWTPM.md +dist_doc_DATA+= docs/WindowTBS.md +dist_doc_DATA+= docs/Doxyfile + + +dox: + echo "Generating HTML" + doxygen ./docs/Doxyfile + +clean-local: + -rm -rf docs/html/