From 27bbcb1e0344f4395df4a3fb52f070b1eaa20c9d Mon Sep 17 00:00:00 2001 From: Jussi Kukkonen Date: Mon, 23 Aug 2021 10:34:02 +0300 Subject: [PATCH] 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 --- docs/api/tuf.api.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/api/tuf.api.rst b/docs/api/tuf.api.rst index cbe17e40cb..72116ec5b2 100644 --- a/docs/api/tuf.api.rst +++ b/docs/api/tuf.api.rst @@ -1,10 +1,13 @@ Metadata API =============== -.. toctree:: - :maxdepth: 4 +The low-level Metadata API contains two modules: - tuf.api.serialization - tuf.api.metadata +* :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