implement draft documentation
(likely by mkdocs)
-
example docs structure
docs/
|- introduction.md
|- installation.md
|- configuration.md
|- tutorial.md
|- manual.md
|- api.md
|- index.md
|- develop.md
-
folder with examples
that are documentated -
docstrings on "api" facing functions and classes -
all compile into html -
make a page about model assumptions - things like the internal model used for the exp_conf time slice and how one could create different internal models and implement functions to compute snrs based on that instead -
add a list of definitions and terms (things like two way range and one way range)
that is all that is needed!
example usage of mkdocs https://github.com/danielk333/pyant
Edited by Tsz-Hin Heung