openstack
/
python-barbicanclient
Code Issues Proposed changes

Merge "Update doc references"

This commit is contained in:
Jenkins 2017-07-20 17:57:46 +00:00 committed by Gerrit Code Review
parent c4971898c4 e599dfd579
commit 574e1fe9e5
2 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/contributor/testing.rst
View File

@ -30,7 +30,7 @@ with the following command:
If you do not have the appropriate Python versions available, consider
setting up PyEnv to install multiple versions of Python. See the
documentation regarding :doc:`/setup/dev` for more information.
documentation `setting up a Barbican development environment <https://github.com/openstack/barbican/blob/master/doc/source/contributor/dev.rst>`_.
.. note::
@ -72,8 +72,8 @@ Functional Tests
Unlike running unit tests, the functional tests require Barbican and
Keystone services to be running in order to execute. For more
information on :doc:`setting up a Barbican development environment
</setup/dev>` and using :doc:`Keystone with Barbican </setup/keystone>`,
information on `setting up a Barbican development environment <https://github.com/openstack/barbican/blob/master/doc/source/contributor/dev.rst>`_
and using `Keystone with Barbican <https://github.com/openstack/barbican/blob/master/doc/source/configuration/keystone.rst>`_,
see our accompanying project documentation.
A configuration file for functional tests must be edited before the tests

30
doc/source/reference/index.rst
View File

@ -11,62 +11,62 @@ Client
Secrets
=======
.. autoclass:: barbicanclient.secrets.SecretManager
.. autoclass:: barbicanclient.v1.secrets.SecretManager
:members:
.. autoclass:: barbicanclient.secrets.Secret
.. autoclass:: barbicanclient.v1.secrets.Secret
:members:
Orders
======
.. autoclass:: barbicanclient.orders.OrderManager
.. autoclass:: barbicanclient.v1.orders.OrderManager
:members:
.. autoclass:: barbicanclient.orders.Order
.. autoclass:: barbicanclient.v1.orders.Order
:members:
.. autoclass:: barbicanclient.orders.KeyOrder
.. autoclass:: barbicanclient.v1.orders.KeyOrder
:members:
.. autoclass:: barbicanclient.orders.AsymmetricOrder
.. autoclass:: barbicanclient.v1.orders.AsymmetricOrder
:members:
Containers
==========
.. autoclass:: barbicanclient.containers.ContainerManager
.. autoclass:: barbicanclient.v1.containers.ContainerManager
:members:
.. autoclass:: barbicanclient.containers.Container
.. autoclass:: barbicanclient.v1.containers.Container
:members:
.. autoclass:: barbicanclient.containers.RSAContainer
.. autoclass:: barbicanclient.v1.containers.RSAContainer
:members:
.. autoclass:: barbicanclient.containers.CertificateContainer
.. autoclass:: barbicanclient.v1.containers.CertificateContainer
:members:
Certificate Authorities
=======================
.. autoclass:: barbicanclient.cas.CAManager
.. autoclass:: barbicanclient.v1.cas.CAManager
:members:
.. autoclass:: barbicanclient.cas.CA
.. autoclass:: barbicanclient.v1.cas.CA
:members:
ACLs
====
.. autoclass:: barbicanclient.acls.ACLManager
.. autoclass:: barbicanclient.v1.acls.ACLManager
:members:
.. autoclass:: barbicanclient.acls.SecretACL
.. autoclass:: barbicanclient.v1.acls.SecretACL
:members:
:inherited-members:
.. autoclass:: barbicanclient.acls.ContainerACL
.. autoclass:: barbicanclient.v1.acls.ContainerACL
:members:
:inherited-members: