Generating API

Any time new methods, classes, etc. are added to the API, you should locally generate new documentation for the API to ensure that your code structure looks the way you want it to and there is plenty of detailed description. To auto-generate API documentation locally:

$ pdoc --html <name-of-code-folder> -o ./docs --force

Generated API documentation can be found within the docs folder. Like the coverage report, the index.html file will report on results at the module level, whereas the *.html files will report on results at the file level. We are not subversioning any API documentation files.