Documentation upgrade

[j-emberton]

Work in progress

Dementpy currently lacks a structured approach to creating and maintaining documentation.

Documentation may be aimed at package users, package developers, or a combination of both. Each group will require slightly different presentation depending on what they need from the Dementpy repo/code.

Below, several strategies that could be used to create and maintain documentation for this project are presented. Each suggested strategy provides an example of a repo where this is the chosen strategy (where possible) as well as a description of how to implement it and the pros and cons of that approach.

Python Docstrings

Simplest approach to creating code documentation. Docstrings should follow a standard such as Google style, Numpy style or restructured text reST (or Sphinx style).

At a minimum, the docstring should contain:

• summary of arguments
• summary of return values
• summary of any exceptions raised
• type descriptions for inputs and outputs