Commit graph

7 commits

Author SHA1 Message Date
Maximilian Nitsch
a837c7d722 docs: Add manpage to mkdocs
Uses pandoc to convert the manpage into a markdown document and add it
to the mkdocs documentation.

Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
2025-06-13 17:55:24 +02:00
Maximilian Nitsch
56f7d5a1ef doc: Remove scalar value types from protoc-gen-doc markdown template
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
2024-12-05 16:36:48 +01:00
Maximilian Nitsch
f1634f090c Makefile: Add make target to build HTML docs
- Add `make doc` target to run protoc-gen-doc before mkdocs
- Ignore auto generated markdown files

Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
2024-12-05 09:31:37 +01:00
Maximilian Nitsch
6bd781656e doc: Remove table of contents from protoc-gen-doc markdown template
Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com>
2024-12-05 09:31:37 +01:00
Maximilian Nitsch
66a47d91e6 doc: Add protoc-gen-doc markdown template
In order to adjust the resulting markdown files to our needs, the
upstream markdown template[^1] is added. The markdown template itself is
added to exclude_docs in the mkdocs.yaml file.

[^1]: https://github.com/pseudomuto/protoc-gen-doc/blob/master/resources/markdown.tmpl

Signed-off-by: Maximilian Nitsch <maximilian.nitsch@d3tn.com
2024-12-05 09:31:37 +01:00
Fiona Fuchs
e249cc3006 Add index.md file, change documentation structure, add new elements and images to folders, add CSS
This performs the following actions:
- change overall documentation tree to adjust to existing material
- add CSS for improved visuals
- add folders to improve structure
- move the README of the Contact Plan Reader to the doc folder and integrate it into the documentation
- add file for 'Home' to provide a starting point for the documentation

Signed-off-by: Fiona Fuchs <fiona.fuchs@d3tn.com>
2024-11-15 07:59:32 +01:00
Felix Walter
8c80cf994c Move mkdocs root directory to top-level
This makes `doc/` the actual documentation root directory to simplify
the repository structure.

Signed-off-by: Felix Walter <felix.walter@d3tn.com>
2024-10-16 16:06:25 +02:00