8000 docs: Include the relevant securesystemslib classes in docs · Issue #2167 · theupdateframework/python-tuf · GitHub
[go: up one dir, main page]

Skip to content
docs: Include the relevant securesystemslib classes in docs #2167
Open
@jku

Description

@jku

Signer, Signature (and in future maybe most of Key) are really part of the Metadata API but are technically implemented in securesystemslib.

We should either include those in the python-tuf API docs, or create similar docs for securesystemslib and link to those (but we don't want to document the rest of securesystemslib API in the same manner).

The former (including in python-tuf api docs) might be quite simple as plain:
.. autoclass:: securesystemslib.signer.Signature
seems to get us most of the way there...

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationDocumentation of the project as well as procedural documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0