mirror of
https://gitlab.com/d3tn/ud3tn.git
synced 2026-08-13 12:33:27 +02:00
421dec1da5
This adds a page explaining the use of the Python module to build an AAP 2.0 client and links it from the corresponding page. Signed-off-by: Felix Walter <felix.walter@d3tn.com> |
||
|---|---|---|
| .. | ||
| css | ||
| development | ||
| image-material | ||
| references | ||
| tools | ||
| usage | ||
| aap20.md | ||
| architecture-overview.md | ||
| Bundle-in-Bundle Encapsulation_(BIBE).md | ||
| contacts_data_format.md | ||
| index.md | ||
| perf_events.md | ||
| posix_quick_start_guide.md | ||
| python-venv.md | ||
| README.md | ||
| sqlite-storage.md | ||
| testing.md | ||
| ud3tn.1 | ||
| ud3tn_aap.md | ||
Documentation
MkDocs
An HTML version of the μD3TN documentation is created via MkDocs. All files stored in the MkDocs directory are taken into account. The MkDocs configuration can be changed in the mkdocs.yaml file. To add further pages to the navigation, they must be added to the nav section.
Prepare
# w/o nix
pip install -U mkdocs
pip install $(mkdocs get-deps)
# w/ nix
nix develop '.?submodules=1'
Develop
mkdocs serve
Build
# w/o nix
mkdocs build --strict --site-dir result/
# w/ nix
nix build .#mkdocs-html
Deploy
When changes are made to the master branch, the latest version of the documentation is automatically built and published at https://d3tn.gitlab.io/ud3tn.
Man Page
There exists also a man page for μD3TN, which can be viewed with
man --local-file ud3tn.1