python-tuf/docs/api/tuf.api.rst
Jussi Kukkonen 1a714f7dc8
docs: Improve tuf.api docs
Write a bit more about the two modules, hide the actual TOC to not
repeat (and not have sphinx complain about missing items in TOC)

Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
2021-08-25 17:05:06 +03:00

13 lines
562 B
ReStructuredText

Metadata API
===============
The low-level Metadata API contains two modules:
* :doc:`tuf.api.metadata` contains the actual Metadata abstraction that higher level libraries and application code should use to interact with TUF metadata. This abstraction provides safe reading and writing to supported file formats and helper functions for accessing and modifying the metadata contents.
* :doc:`tuf.api.serialization` covers serializing the metadata into specific wire formats (like json).
.. toctree::
:hidden:
tuf.api.metadata
tuf.api.serialization