add docu build script

This commit is contained in:
Bastian Schroll 2019-09-19 17:34:59 +02:00
parent 642595fb9a
commit f4125ce9fb
3 changed files with 16 additions and 3 deletions

View file

@ -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

View file

@ -92,6 +92,7 @@ ALLOW_UNICODE_NAMES = NO
# The default value is: English. # The default value is: English.
OUTPUT_LANGUAGE = English OUTPUT_LANGUAGE = English
#German
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # 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 # descriptions after the members that are listed in the file and class
@ -673,7 +674,7 @@ SHOW_USED_FILES = YES
# (if specified). # (if specified).
# The default value is: YES. # 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 # 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 # page. This will remove the Namespaces entry from the Quick Index and from the
@ -876,7 +877,8 @@ RECURSIVE = YES
EXCLUDE = bw_client.py \ EXCLUDE = bw_client.py \
bw_server.py \ bw_server.py \
FileHead.template.py \ FileHead.template.py \
venv venv \
docu
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # 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 # directories that are symbolic links (a Unix file system feature) are excluded

View file

@ -22,7 +22,7 @@ nav:
- Entwickler: - Entwickler:
- Eigenes Modul/Plugin: develop/ModulPlugin.md - Eigenes Modul/Plugin: develop/ModulPlugin.md
- BOSWatch Packet Format: develop/packet.md - BOSWatch Packet Format: develop/packet.md
- BW3 Source Docu: /api/html/index.html - BW3 Source Docu: api/html/index.html
- Changelog: changelog.md - Changelog: changelog.md
use_directory_urls: false use_directory_urls: false