thealphadollar/Nephos

Improve Developer Documentation

thealphadollar opened this issue · 0 comments

Describe the bug
The current developer's documentation is not sufficient and lacks at many levels.

To Reproduce
None

Expected behavior
Developer documentation should contain per page all the function doc-strings and also the list of global variables used. There should be (but not necessarily) link to the side effects of the function which will be present on a different page.

Screenshots
None

Additional context
The current documentation was generated using PyDoc. Below are a few resources to try out different methods of the generation of documentation from docstrings. The best part is that it will automatically follow the folder schema.

https://python-docs.readthedocs.io/en/latest/writing/documentation.html
https://stackoverflow.com/questions/26587763/how-to-generate-documentation-using-pydoc