This manual is mkdocs based.
Install mkdocs, mtdocs material and rtd-dropdown theme
python -m pip install mkdocs python -m pip install mkdocs-material python -m pip install mkdocs-pdf-export-plugin
Important: Each file name needs to be the same as the first heading in each file.
View documentation locally
This command starts a local webserver at localhost:8000.
Build static documentation files (HTML)
This command builds the documentation in ./site/
Deploy to Github Pages
Will build the static files and push to the gh-pages branch on Github, so they will be served automatically at manual.bt-trx.com
Currently, the mkdocs-pdf-export-plugin can't handle anchors, therefore it is necessary to temporarily alter links containing anchors i.e. from "(../PTT-Taste#soft-ptt)" to "(../PTT-Taste.md#soft-ptt)" to be able to generate a PDF file.
export ENABLE_PDF_EXPORT=1 mkdocs build