From f4125ce9fb751fe2bcde96801c130557c4520238 Mon Sep 17 00:00:00 2001 From: Bastian Schroll Date: Thu, 19 Sep 2019 17:34:59 +0200 Subject: [PATCH] add docu build script --- build_docu.sh | 11 +++++++++++ docu/doxygen.ini | 6 ++++-- docu/mkdocs.yml | 2 +- 3 files changed, 16 insertions(+), 3 deletions(-) diff --git a/build_docu.sh b/build_docu.sh index e69de29..204190b 100644 --- a/build_docu.sh +++ b/build_docu.sh @@ -0,0 +1,11 @@ +#!/bin/bash + +echo "clean api documentation" +rm -r docu/docs/api/html +echo "generate api documentation" +doxygen docu/doxygen.ini + +echo "build documentation" +source ./venv/bin/activate +python3 -m mkdocs build -f docu/mkdocs.yml +deactivate \ No newline at end of file diff --git a/docu/doxygen.ini b/docu/doxygen.ini index 259fd50..2c215c5 100644 --- a/docu/doxygen.ini +++ b/docu/doxygen.ini @@ -92,6 +92,7 @@ ALLOW_UNICODE_NAMES = NO # The default value is: English. OUTPUT_LANGUAGE = English +#German # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class @@ -673,7 +674,7 @@ SHOW_USED_FILES = YES # (if specified). # The default value is: YES. -SHOW_FILES = YES +SHOW_FILES = NO # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the @@ -876,7 +877,8 @@ RECURSIVE = YES EXCLUDE = bw_client.py \ bw_server.py \ FileHead.template.py \ - venv + venv \ + docu # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded diff --git a/docu/mkdocs.yml b/docu/mkdocs.yml index bd90af3..01dcb0f 100644 --- a/docu/mkdocs.yml +++ b/docu/mkdocs.yml @@ -22,7 +22,7 @@ nav: - Entwickler: - Eigenes Modul/Plugin: develop/ModulPlugin.md - BOSWatch Packet Format: develop/packet.md - - BW3 Source Docu: /api/html/index.html + - BW3 Source Docu: api/html/index.html - Changelog: changelog.md use_directory_urls: false