Skip to content

Commit

Permalink
doc: add basic Signer API overview to RTD docs
Browse files Browse the repository at this point in the history
Signed-off-by: Lukas Puehringer <[email protected]>
  • Loading branch information
lukpueh committed Aug 21, 2023
1 parent fff0a81 commit 0989edd
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
Welcome to ``securesystemslib``
===============================

A cryptography interface to sign and verify `TUF
<https://theupdateframework.io>`_ and `in-toto <https://in-toto.io>`_ metadata.

.. note::
This documentation is built for
`securesystemslib (Python) <https://github.com/secure-systems-lab/securesystemslib>`_, used by
`python-tuf <https://github.com/theupdateframework/python-tuf/>`_ and
`in-toto (Python) <https://github.com/in-toto/in-toto>`_ reference implementations.

.. toctree::
:maxdepth: 2
:caption: Contents

signer
21 changes: 21 additions & 0 deletions docs/signer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Signer API
==========

.. currentmodule:: securesystemslib.signer

.. warning::
The API is experimental and may change without warning in versions ``<1.0.0``.

See `'New Signer API' <https://theupdateframework.github.io/python-tuf/2023/01/24/securesystemslib-signer-api.html>`_ blog post
for background infos.


.. Autodoc cannot resolve docs for imported globals (sphinx-doc/sphinx#6495)
.. As workaround we reference their original internal definition.
.. autodata:: securesystemslib.signer._signer.SIGNER_FOR_URI_SCHEME
:no-value:
.. autodata:: securesystemslib.signer._key.KEY_FOR_TYPE_AND_SCHEME
:no-value:
.. autoclass:: securesystemslib.signer.Signer
.. autoclass:: securesystemslib.signer.Key
.. autoclass:: securesystemslib.signer.Signature

0 comments on commit 0989edd

Please sign in to comment.