Add documentation with MkDocs to VAPython
This MR add a documentation site to VAPython.
For this it uses MkDocs and MkDocstrings. The docs for the generated VA interface are stored in a separate toml
file.
Maybe in the future, this doc file can be used as a unified documentation for all modules that implement some sort of VA interface.
Merge request reports
Activity
added documentation enhancement labels
assigned to @pascal.palenda
added 1 commit
- b95dbccd - Revert "Fix: build by setting fixed python version in default evn"
added 73 commits
-
b95dbccd...fae5d2b6 - 44 commits from branch
feature/pure-python
- fae5d2b6...014dc93d - 19 earlier commits
- c5eb33d2 - Doc: `_types`
- 6178910c - Doc: functions
- 54ccc567 - Feat: add some todos
- 43cad87a - Feat: disable file documentation for doc-coverage
- 178fc6fe - Style: doc formatting
- d53b7c9c - Style: doc formatting
- 4fa2633d - Chore: add punctuation to doc strings
- 04a722ae - Style: doc formatting
- 744ef5aa - Doc: add todo
- 4cf5ec6d - Chore: update `docstr_coverage_badge`
Toggle commit list-
b95dbccd...fae5d2b6 - 44 commits from branch
Todo:
- Adapt parameter names when VANet!4 (merged) is finished.
Edited by Pascal Palendaadded 2 commits
Removed the dependency on VANet!4 (merged) so that in can be merged into !4 (merged)
requested review from @schaefer
- Resolved by Pascal Palenda
- Resolved by Pascal Palenda
- Resolved by Pascal Palenda
- Resolved by Pascal Palenda
- Resolved by Pascal Palenda
Please register or sign in to reply