python-tuf/docs/index.rst
Kairo de Araujo 23534790cd docs: add examples to the RTD
This commit adds to the RTD the links references to source code
examples.
The examples are added to TUF ngclient Updater, Metadata and API
reference.
includes a seed for examples/README.md

Signed-off-by: Kairo de Araujo <kdearaujo@vmware.com>
2022-01-18 13:14:02 +01:00

20 lines
No EOL
694 B
ReStructuredText

TUF Developer Documentation
===========================
This documentation provides essential information for those developing software
with the `Python reference implementation of The Update Framework (TUF)
<https://github.com/theupdateframework/python-tuf>`_.
The reference implementation provides easy-to-use components for Python
developers but also aims to be a readable guide and demonstration for those
working on implementing TUF in their own languages, environments, or update
systems.
.. toctree::
:maxdepth: 1
:caption: Contents:
api/api-reference
INSTALLATION
Usage examples <https://github.com/theupdateframework/python-tuf/tree/develop/examples>
CONTRIBUTORS