docs: rename "helpers" to "supporting classes"

Also add a summary to the page -- unfortunately getting a standard
TOC would require creating a rst page for each class.

Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
This commit is contained in:
Jussi Kukkonen 2021-09-23 17:06:17 +03:00
parent 892aa04cb3
commit a77c0831e7
4 changed files with 29 additions and 16 deletions

View file

@ -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

View file

@ -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

View file

@ -12,7 +12,7 @@ Metadata API
.. toctree::
:hidden:
tuf.api.metadata.helpers
tuf.api.metadata.supporting
tuf.api.serialization
.. automodule:: tuf.api.metadata

View file

@ -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']