WolfSSL
/
wolfTPM
mirror of https://github.com/wolfSSL/wolfTPM.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Fix for "make dox" to use the right README.md.

pull/164/head
David Garske 2021-06-01 10:55:17 -07:00
parent 6bef9cd46b
commit 6daac56d1a
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/Doxyfile
View File

@ -865,7 +865,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched. # Note: If this tag is empty the current directory is searched.
INPUT = ./README.md ./wolftpm/doxygen.h ./wolftpm/tpm2.h ./wolftpm/tpm2_wrap.h INPUT = ./docs/README.md ./wolftpm/doxygen.h ./wolftpm/tpm2.h ./wolftpm/tpm2_wrap.h
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@ -1063,7 +1063,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub # (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output. # and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE = README.md USE_MDFILE_AS_MAINPAGE = docs/README.md
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to source browsing # Configuration options related to source browsing

6
docs/generate_documentation.sh
View File

@ -1,14 +1,14 @@
#!/bin/bash #!/bin/bash
CURRDIR=${PWD##*/} CURRDIR=${PWD##*/}
if [ "$CURRDIR" != "docs" ]; then if [ "$CURRDIR" = "docs" ]; then
echo "Please run from the ./docs directory" echo "Please run from the wolfTPM root directory"
exit 1 exit 1
fi fi
# Run from ./docs # Run from ./docs
echo "Generating html..." echo "Generating html..."
doxygen Doxyfile doxygen ./docs/Doxyfile
echo "Finished generating html..." echo "Finished generating html..."
echo "To view the html files use a browser to open the index.html file located at docs/html/index.html" echo "To view the html files use a browser to open the index.html file located at docs/html/index.html"