0863f04a26
There were two main issues here. Firstly, a function was being documented as a class, resulting in: WARNING: error while formatting arguments for barbicanclient.client.Client: 'function' object has no attribute '__mro__' Secondly, a docstring for a common function had an incorrect field list format, resulting in: docstring of barbicanclient.v1.acls.SecretACL.get:4: WARNING: Field list ends without a blank line; unexpected unindent docstring of barbicanclient.v1.acls.ContainerACL.get:4: WARNING: Field list ends without a blank line; unexpected unindent Resolve both. Change-Id: I69ef97cb48c6b5a1add4e89c4a53047420d314f4 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
77 lines
1.3 KiB
ReStructuredText
77 lines
1.3 KiB
ReStructuredText
=========
|
|
Reference
|
|
=========
|
|
|
|
Client
|
|
======
|
|
|
|
.. autofunction:: barbicanclient.client.Client
|
|
|
|
Secrets
|
|
=======
|
|
|
|
.. autoclass:: barbicanclient.v1.secrets.SecretManager
|
|
:members:
|
|
|
|
.. autoclass:: barbicanclient.v1.secrets.Secret
|
|
:members:
|
|
|
|
Orders
|
|
======
|
|
|
|
.. autoclass:: barbicanclient.v1.orders.OrderManager
|
|
:members:
|
|
|
|
.. autoclass:: barbicanclient.v1.orders.Order
|
|
:members:
|
|
|
|
.. autoclass:: barbicanclient.v1.orders.KeyOrder
|
|
:members:
|
|
|
|
.. autoclass:: barbicanclient.v1.orders.AsymmetricOrder
|
|
:members:
|
|
|
|
Containers
|
|
==========
|
|
|
|
.. autoclass:: barbicanclient.v1.containers.ContainerManager
|
|
:members:
|
|
|
|
.. autoclass:: barbicanclient.v1.containers.Container
|
|
:members:
|
|
|
|
.. autoclass:: barbicanclient.v1.containers.RSAContainer
|
|
:members:
|
|
|
|
.. autoclass:: barbicanclient.v1.containers.CertificateContainer
|
|
:members:
|
|
|
|
Certificate Authorities
|
|
=======================
|
|
|
|
.. autoclass:: barbicanclient.v1.cas.CAManager
|
|
:members:
|
|
|
|
.. autoclass:: barbicanclient.v1.cas.CA
|
|
:members:
|
|
|
|
ACLs
|
|
====
|
|
|
|
.. autoclass:: barbicanclient.v1.acls.ACLManager
|
|
:members:
|
|
|
|
.. autoclass:: barbicanclient.v1.acls.SecretACL
|
|
:members:
|
|
:inherited-members:
|
|
|
|
.. autoclass:: barbicanclient.v1.acls.ContainerACL
|
|
:members:
|
|
:inherited-members:
|
|
|
|
Exceptions
|
|
==========
|
|
|
|
.. automodule:: barbicanclient.exceptions
|
|
:members:
|