From e599dfd5791c7dbafebfa47e55ce31e7da7478ec Mon Sep 17 00:00:00 2001 From: Jeremy Liu Date: Mon, 17 Jul 2017 11:14:19 +0800 Subject: [PATCH] Update doc references We have two documents referenced from barbican repo, update the references to enable the link. Also update api references according to recent refactor patch [1]. [1] https://review.openstack.org/#/c/403604/ Change-Id: I9cb593e60cfb5220a56356f3f807bbb9ace0cb1c --- doc/source/contributor/testing.rst | 6 +++--- doc/source/reference/index.rst | 30 +++++++++++++++--------------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst index e94ce752..03da8f3f 100644 --- a/doc/source/contributor/testing.rst +++ b/doc/source/contributor/testing.rst @@ -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 `_. .. 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 -` and using :doc:`Keystone with Barbican `, +information on `setting up a Barbican development environment `_ +and using `Keystone with Barbican `_, see our accompanying project documentation. A configuration file for functional tests must be edited before the tests diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 27f83a61..791d5d15 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -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: