diff --git a/doc/README_DOXYGEN b/doc/README_DOXYGEN index 4fad8ca40..871c6b79e 100644 --- a/doc/README_DOXYGEN +++ b/doc/README_DOXYGEN @@ -5,21 +5,19 @@ wolfSSL with Doxygen 1.8.13 cmake make git -latex (With pdflatex included. However the pdflatex dependency can be removed by +latex-see below (With pdflatex included. However the pdflatex dependency can be removed by setting USE_PDFLATEX to NO in the file "Doxyfile" located at doc/formats/pdf/Doxyfile ) -The following texlive packages were used when creating this -documentation: -texlive [installed] -texlive-base [installed,automatic] -texlive-binaries [installed] -texlive-font-utils [installed] -texlive-fonts-recommended [installed,automatic] -texlive-latex-base [installed,automatic] -texlive-latex-extra [installed] -texlive-latex-recommended [installed] -texlive-pictures [installed,automatic] +The following texlive packages were installed when creating this +documentation on Linux Mint: +sudo apt install texlive +sudo apt install texlive-latex-extra + +For Mac users Basic Tex from TUG is recommended. After installing BasicTex +additional dependencies will need to be met: +% sudo tlmgr update --self +% sudo tlmgr install tabu varwidth multirow adjustbox collectbox sectsty tocloft collection-fontsextra ---- Generating the Documentation ---- diff --git a/doc/generate_documentation.sh b/doc/generate_documentation.sh index a6ec5b59c..2f094f0f6 100755 --- a/doc/generate_documentation.sh +++ b/doc/generate_documentation.sh @@ -24,6 +24,13 @@ echo "Please install make" exit 1 fi +./check_api.sh + +if [ $? = 1 ]; then +echo "Not all API match" +exit 1 +fi + if [ ! -e "build/bin/doxygen" ]; then mkdir -p build cd build diff --git a/doc/include.am b/doc/include.am index 0dde86406..6339f0f1f 100644 --- a/doc/include.am +++ b/doc/include.am @@ -6,11 +6,11 @@ dist_doc_DATA+= doc/README.txt dox-pdf: echo "Generating PDF" - cd doc && ./generate_documentation.sh -pdf > ./doxygen_pdf_warnings || (echo "HTML generation failed $$?"; exit 1) + cd doc && ./generate_documentation.sh -pdf || (echo "HTML generation failed $$?"; exit 1) dox-html: echo "Generating HTML" - cd doc && ./generate_documentation.sh -html > ./doxygen_html_warnings || (echo "HTML generation failed $$?"; exit 1) + cd doc && ./generate_documentation.sh -html || (echo "HTML generation failed $$?"; exit 1) dox: dox-html dox-pdf @@ -19,5 +19,3 @@ clean-local: -rm -rf doc/html/ -rm -f doc/refman.pdf -rm -f doc/doxygen_warnings - -rm -f doc/doxygen_html_warnings - -rm -f doc/doxygen_pdf_warnings