python-tuf/docs/api/tuf.ngclient.rst

ngclient
========

The ngclient module contains a complete TUF client library implementation.

* :doc:`tuf.ngclient.updater` implements the `detailed client workflow`_
* :doc:`tuf.ngclient.config` provides optional configuration for the updater
* :doc:`tuf.ngclient.fetcher` can be used for optional low-level network I/O control


.. toctree::
   :hidden:

   tuf.ngclient.updater
   tuf.ngclient.config
   tuf.ngclient.fetcher

.. _detailed client workflow: https://theupdateframework.github.io/specification/latest/#detailed-client-workflow
docs: API Reference tweaks * Improve content * Make ngclient Updater __init__() visible in docs * Remove "legacy implementation" (except for the note on API stability) Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com> 2021-08-19 13:14:57 +00:00			`ngclient`
			`========`
Add sphinx docs source files Add .rst source files for building documentation with 'sphinx'. The two mandatory files are conf.py containing the build configuration and the master doc file index.rst. Sphinx uses 'autodoc' to automatically include docstrings. 'autodoc' imports the modules and needs TUF installed in the environment. The following command will generate the documentation from the source files in an html format: `sphinx-build -b html docs/sphinx/source docs/sphinx/build/html` Signed-off-by: Teodora Sechkova <tsechkova@vmware.com> 2021-08-09 12:23:54 +00:00
docs: Improve ngclient docs Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com> 2021-08-23 07:46:25 +00:00			`The ngclient module contains a complete TUF client library implementation.`

docs: Add links to the specification Signed-off-by: Teodora Sechkova <tsechkova@vmware.com> 2021-08-25 13:59:31 +00:00			* :doc:`tuf.ngclient.updater` implements the `detailed client workflow`_
docs: Improve ngclient docs Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com> 2021-08-23 07:46:25 +00:00			* :doc:`tuf.ngclient.config` provides optional configuration for the updater
			* :doc:`tuf.ngclient.fetcher` can be used for optional low-level network I/O control


Add sphinx docs source files Add .rst source files for building documentation with 'sphinx'. The two mandatory files are conf.py containing the build configuration and the master doc file index.rst. Sphinx uses 'autodoc' to automatically include docstrings. 'autodoc' imports the modules and needs TUF installed in the environment. The following command will generate the documentation from the source files in an html format: `sphinx-build -b html docs/sphinx/source docs/sphinx/build/html` Signed-off-by: Teodora Sechkova <tsechkova@vmware.com> 2021-08-09 12:23:54 +00:00			`.. toctree::`
docs: Improve ngclient docs Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com> 2021-08-23 07:46:25 +00:00			`:hidden:`
Add sphinx docs source files Add .rst source files for building documentation with 'sphinx'. The two mandatory files are conf.py containing the build configuration and the master doc file index.rst. Sphinx uses 'autodoc' to automatically include docstrings. 'autodoc' imports the modules and needs TUF installed in the environment. The following command will generate the documentation from the source files in an html format: `sphinx-build -b html docs/sphinx/source docs/sphinx/build/html` Signed-off-by: Teodora Sechkova <tsechkova@vmware.com> 2021-08-09 12:23:54 +00:00
			`tuf.ngclient.updater`
			`tuf.ngclient.config`
			`tuf.ngclient.fetcher`

docs: Add links to the specification Signed-off-by: Teodora Sechkova <tsechkova@vmware.com> 2021-08-25 13:59:31 +00:00			`.. _detailed client workflow: https://theupdateframework.github.io/specification/latest/#detailed-client-workflow`