diff --git a/docs/api/tuf.api.metadata.helpers.rst b/docs/api/tuf.api.metadata.helpers.rst deleted file mode 100644 index a1f7dcfe..00000000 --- a/docs/api/tuf.api.metadata.helpers.rst +++ /dev/null @@ -1,14 +0,0 @@ -Helper classes ---------------------------------- - -.. autoclass:: tuf.api.metadata.DelegatedRole - -.. autoclass:: tuf.api.metadata.Delegations - -.. autoclass:: tuf.api.metadata.Key - -.. autoclass:: tuf.api.metadata.MetaFile - -.. autoclass:: tuf.api.metadata.Role - -.. autoclass:: tuf.api.metadata.TargetFile diff --git a/docs/api/tuf.api.metadata.supporting.rst b/docs/api/tuf.api.metadata.supporting.rst new file mode 100644 index 00000000..906e70e9 --- /dev/null +++ b/docs/api/tuf.api.metadata.supporting.rst @@ -0,0 +1,27 @@ +Supporting classes +--------------------------------- + +The Metadata API includes multiple classes that are used by the top-level +ones (Root, Timestamp, Snapshot, Targets): + +.. autosummary:: + :nosignatures: + + tuf.api.metadata.DelegatedRole + tuf.api.metadata.Delegations + tuf.api.metadata.Key + tuf.api.metadata.MetaFile + tuf.api.metadata.Role + tuf.api.metadata.TargetFile + +.. autoclass:: tuf.api.metadata.DelegatedRole + +.. autoclass:: tuf.api.metadata.Delegations + +.. autoclass:: tuf.api.metadata.Key + +.. autoclass:: tuf.api.metadata.MetaFile + +.. autoclass:: tuf.api.metadata.Role + +.. autoclass:: tuf.api.metadata.TargetFile diff --git a/docs/api/tuf.api.rst b/docs/api/tuf.api.rst index de6eb954..d4309b84 100644 --- a/docs/api/tuf.api.rst +++ b/docs/api/tuf.api.rst @@ -12,7 +12,7 @@ Metadata API .. toctree:: :hidden: - tuf.api.metadata.helpers + tuf.api.metadata.supporting tuf.api.serialization .. automodule:: tuf.api.metadata diff --git a/docs/conf.py b/docs/conf.py index 71f1f137..cb146ed9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,7 +30,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['sphinx.ext.napoleon'] +extensions = ['sphinx.ext.napoleon', 'sphinx.ext.autosummary'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']