Write documentation from code

srounet / Pymem

A python library for windows, providing the needed functions to start working on your own with memory editing.

MIT License

307 stars 44 forks source link

Write documentation from code #10

Closed srounet closed 4 years ago

srounet commented 6 years ago

Generating documentation that reflects the current version of the code should not be a pain in the ass. There are things to automate that like the popular sphinx.

The numpy style seems to be a nice approach as it allows embedding code examples and method description within docstrings. See sphinx napoleon plugin.

srounet commented 4 years ago

this as been resolved with documentation branch, and now merged within master (1.4)