Generate Internal API documentation

[robons]

We should use an API documentation generation tool like Sphinx to generate the documentation we need to show what classes/functions are available/how they are related and any docstrings they have explaining their use.

• Each project (devtools/sharedmodels/PMD/csvwlib) should generate their own docs.
• A Jenkins job should be created to generate these docs, they should be output as a ZIP artifact for the build process.
• The docs should be available as a (searchable) static HTML website.

Do we want to publish the static site somewhere or are we happy having a ZIP file to download at this stage? - We're happy enough with a ZIP for now.

[robons]

@mikeAdamss has suggested we consider using mitmproxy/pdoc. Is worth considering using instead of sphinx when doing this ticket.

[robons]

Some useful links for managing the current sphinx configuration I have setup:

• sphinx-apidoc
• sphinx-autodoc

Each project's API documentation config file can be found in docs/conf.py. That's where we configure things like the function names which are ignored, the ordering of the functions/attributes in classes/modules and the intersphinx referencing.