Document ngclient

[jku]

• Document the ngclient.updater module
• Include the simplest possible example
• Try out some sphinx links and layout

I've tested this with sphinx (+ napoleon plugin for google docstrings) and it works.

I did not go all-in with the sphinx links as it looks quite ugly in the source code -- not sure which to optimize here.

[jku]

I should file issues for the "implement docs build, publish on readthedocs" steps but I'm not entirely sure what that really includes...

My quick-and-dirty test method:

• install sphinx
• configure with sphinx-quickstart
• Add extensions = ['sphinx.ext.napoleon'] to conf.py to get support for google style docstrings
• run docs build (e.g. make html)

[sechkova]

I think this is a good starting point for documenting the client. We can most likely find a ways to improve it while we keep tuning the client API and publishing the docs.

Yeah, the links look a bit ugly in the source but are useful in the html.

[sechkova]

My quick-and-dirty test method:

* install sphinx
* configure with `sphinx-quickstart`
* Add `extensions = ['sphinx.ext.napoleon']` to conf.py to get support for google style docstrings
* run docs build (e.g. `make html`)

I had to add some settings so that autodoc is able to find the module too?
edit: probably I didn't import TUF from the very beginning and the autodocs tweaks were not needed.

[joshuagl]

Thanks, this looks like a decent start. Let's merge and iterate.