Open madig opened 6 years ago
I propose we not only write, but also generate documentation to make user's lives easier.
See https://github.com/RookieGameDevs/revived/tree/master/revived and https://revived.readthedocs.io/en/stable/api.html for an example. Note the structure of the docstrings and what they're turned into.
So, we need to:
https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
I propose we not only write, but also generate documentation to make user's lives easier.
See https://github.com/RookieGameDevs/revived/tree/master/revived and https://revived.readthedocs.io/en/stable/api.html for an example. Note the structure of the docstrings and what they're turned into.
So, we need to: