mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
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:
parent
892aa04cb3
commit
a77c0831e7
4 changed files with 29 additions and 16 deletions
|
|
@ -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
|
||||
27
docs/api/tuf.api.metadata.supporting.rst
Normal file
27
docs/api/tuf.api.metadata.supporting.rst
Normal 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
|
||||
|
|
@ -12,7 +12,7 @@ Metadata API
|
|||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
tuf.api.metadata.helpers
|
||||
tuf.api.metadata.supporting
|
||||
tuf.api.serialization
|
||||
|
||||
.. automodule:: tuf.api.metadata
|
||||
|
|
|
|||
|
|
@ -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']
|
||||
|
|
|
|||
Loading…
Reference in a new issue