summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeremy Liu <liujiong@gohighsec.com>2017-07-17 11:14:19 +0800
committerJeremy Liu <liujiong@gohighsec.com>2017-07-17 11:21:07 +0800
commite599dfd5791c7dbafebfa47e55ce31e7da7478ec (patch)
tree9f1c4b45d6f2692ceb255f4a294d902a268c03ef
parent4a3c7cd23a22cb9f8fd376e3de3a6f4f6c69da0d (diff)
downloadpython-barbicanclient-e599dfd5791c7dbafebfa47e55ce31e7da7478ec.tar.gz
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
-rw-r--r--doc/source/contributor/testing.rst6
-rw-r--r--doc/source/reference/index.rst30
2 files changed, 18 insertions, 18 deletions
diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst
index e94ce75..03da8f3 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 <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
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
index 27f83a6..791d5d1 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: