TestInABox · BenjamenMeyer · Sep 14, 2017 · Nov 10, 2017 · Dec 1, 2017 · Dec 8, 2017
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = OpenStack-In-A-Box
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,10 @@
+Class and Functions
+===================
+
+.. toctree::
+    :maxdepth: 2
+
+    manager
+    models/index
+    services/index
+    utils/index
diff --git a/docs/api/manager.rst b/docs/api/manager.rst
@@ -0,0 +1,23 @@
+.. _manager:
+
+OpenStackInABox Manager
+=======================
+
+.. currentmodule:: openstackinabox.manager
+
+Exceptions
+----------
+
+.. autoexception:: OpenStackServiceManagerException
+
+.. autoexception:: ServiceNotAvailable
+
+.. autoexception:: ServiceVersionNotAvailable
+
+.. autoexception:: KeystoneUrlNotSet
+
+Manager
+-------
+
+.. autoclass:: OpenStackServicesManager
+    :members:
diff --git a/docs/api/models/base_db.rst b/docs/api/models/base_db.rst
@@ -0,0 +1,9 @@
+.. _base_db:
+
+Model Database Base
+===================
+
+.. currentmodule:: openstackinabox.models.base_db
+
+.. autoclass:: ModelDbBase
+    :members:
diff --git a/docs/api/models/base_model.rst b/docs/api/models/base_model.rst
@@ -0,0 +1,11 @@
+.. _base_model:
+
+Base Model
+==========
+
+.. currentmodule:: openstackinabox.models.base_model
+
+.. autoexception:: BaseModelExceptions
+
+.. autoclass:: BaseModel
+    :members:
diff --git a/docs/api/models/cinder/index.rst b/docs/api/models/cinder/index.rst
@@ -0,0 +1,9 @@
+OpenStack Cinder Services
+=========================
+
+.. currentmodule:: openstackinabox.models.cinder
+
+.. toctree::
+    :maxdepth: 2
+
+    model
diff --git a/docs/api/models/cinder/model.rst b/docs/api/models/cinder/model.rst
@@ -0,0 +1,9 @@
+.. _cinder_model:
+
+Cinder Model
+============
+
+.. currentmodule:: openstackinabox.models.cinder.model
+
+.. autoclass:: CinderModel
+    :members:
diff --git a/docs/api/models/index.rst b/docs/api/models/index.rst
@@ -0,0 +1,13 @@
+OpenStack Service Models
+========================
+
+.. currentmodule:: openstackinabox.models
+
+.. toctree::
+    :maxdepth: 2
+
+    base_db
+    base_model
+    cinder/index
+    keystone/index
+    swift/index
diff --git a/docs/api/models/keystone/db/base.rst b/docs/api/models/keystone/db/base.rst
@@ -0,0 +1,9 @@
+.. _keystone_db_base:
+
+Keystone Database Base
+======================
+
+.. currentmodule:: openstackinabox.models.keystone.db.base
+
+.. autoclass:: KeystoneDbBase
+    :members:
diff --git a/docs/api/models/keystone/db/endpoints.rst b/docs/api/models/keystone/db/endpoints.rst
@@ -0,0 +1,9 @@
+.. _keystone_db_endpoints:
+
+Keystone Endpoints Database
+===========================
+
+.. currentmodule:: openstackinabox.models.keystone.db.endpoints
+
+.. autoclass:: KeystoneDbServiceEndpoints
+    :members:
diff --git a/docs/api/models/keystone/db/index.rst b/docs/api/models/keystone/db/index.rst
@@ -0,0 +1,15 @@
+OpenStack Keystone Services
+===========================
+
+.. currentmodule:: openstackinabox.models.keystone.db
+
+.. toctree::
+    :maxdepth: 2
+
+    base
+    endpoints
+    roles
+    services
+    tenants
+    tokens
+    users
diff --git a/docs/api/models/keystone/db/roles.rst b/docs/api/models/keystone/db/roles.rst
@@ -0,0 +1,9 @@
+.. _keystone_db_roles:
+
+Keystone Roles Database
+=======================
+
+.. currentmodule:: openstackinabox.models.keystone.db.roles
+
+.. autoclass:: KeystoneDbRoles
+    :members:
diff --git a/docs/api/models/keystone/db/services.rst b/docs/api/models/keystone/db/services.rst
@@ -0,0 +1,9 @@
+.. _keystone_db_services:
+
+Keystone Services Database
+==========================
+
+.. currentmodule:: openstackinabox.models.keystone.db.services
+
+.. autoclass:: KeystoneDbServices
+    :members:
diff --git a/docs/api/models/keystone/db/tenants.rst b/docs/api/models/keystone/db/tenants.rst
@@ -0,0 +1,9 @@
+.. _keystone_db_tenants:
+
+Keystone Tenants Database
+=========================
+
+.. currentmodule:: openstackinabox.models.keystone.db.tenants
+
+.. autoclass:: KeystoneDbTenants
+    :members:
diff --git a/docs/api/models/keystone/db/tokens.rst b/docs/api/models/keystone/db/tokens.rst
@@ -0,0 +1,9 @@
+.. _keystone_db_tokens:
+
+Keystone Tokens Database
+========================
+
+.. currentmodule:: openstackinabox.models.keystone.db.tokens
+
+.. autoclass:: KeystoneDbTokens
+    :members:
diff --git a/docs/api/models/keystone/db/users.rst b/docs/api/models/keystone/db/users.rst
@@ -0,0 +1,9 @@
+.. _keystone_db_users:
+
+Keystone Users Database
+=======================
+
+.. currentmodule:: openstackinabox.models.keystone.db.users
+
+.. autoclass:: KeystoneDbUsers
+    :members:
diff --git a/docs/api/models/keystone/exceptions.rst b/docs/api/models/keystone/exceptions.rst
@@ -0,0 +1,40 @@
+.. _keystone_model_exceptions:
+
+Keystone Model Exceptions
+=========================
+
+.. currentmodule:: openstackinabox.models.keystone.exceptions
+
+.. autoexception:: KeystoneError
+
+.. autoexception:: KeystoneTenantError
+
+.. autoexception:: KeystoneUserError
+
+.. autoexception:: KeystoneDisabledUserError
+
+.. autoexception:: KeystoneUnknownUserError
+
+.. autoexception:: KeystoneUserAuthError
+
+.. autoexception:: KeystoneUserInvalidPasswordError
+
+.. autoexception:: KeystoneUserInvalidApiKeyError
+
+.. autoexception:: KeystoneTokenError
+
+.. autoexception:: KeystoneInvalidTokenError
+
+.. autoexception:: KeystoneRevokedTokenError
+
+.. autoexception:: KeystoneExpiredTokenError
+
+.. autoexception:: KeystoneRoleError
+
+.. autoexception:: KeystoneServiceCatalogError
+
+.. autoexception:: KeystoneServiceCatalogServiceError
+
+.. autoexception:: KeystoneServiceCatalogEndpointError
+
+.. autoexception:: KeystoneEndpointUrlError
diff --git a/docs/api/models/keystone/index.rst b/docs/api/models/keystone/index.rst
@@ -0,0 +1,11 @@
+OpenStack Keystone Services
+===========================
+
+.. currentmodule:: openstackinabox.models.keystone
+
+.. toctree::
+    :maxdepth: 2
+
+    exceptions
+    model
+    db/index
diff --git a/docs/api/models/keystone/model.rst b/docs/api/models/keystone/model.rst
@@ -0,0 +1,9 @@
+.. _keystone_model:
+
+Keystone Model
+==============
+
+.. currentmodule:: openstackinabox.models.keystone.model
+
+.. autoclass:: KeystoneModel
+    :members:
diff --git a/docs/api/models/swift/exceptions.rst b/docs/api/models/swift/exceptions.rst
@@ -0,0 +1,14 @@
+.. _swift_model_exceptions:
+
+Swift Model Exceptions
+======================
+
+.. currentmodule:: openstackinabox.models.swift.exceptions
+
+.. autoexception:: SwiftExceptions
+
+.. autoexception:: SwiftUnknownTenantError
+
+.. autoexception:: SwiftUnknownContainerError
+
+.. autoexception:: SwiftUnknownObjectError
diff --git a/docs/api/models/swift/index.rst b/docs/api/models/swift/index.rst
@@ -0,0 +1,11 @@
+OpenStack Swift Services
+=========================
+
+.. currentmodule:: openstackinabox.models.swift
+
+.. toctree::
+    :maxdepth: 2
+
+    exceptions
+    model
+    storage
diff --git a/docs/api/models/swift/model.rst b/docs/api/models/swift/model.rst
@@ -0,0 +1,9 @@
+.. _swift_model:
+
+Swift Model
+===========
+
+.. currentmodule:: openstackinabox.models.swift.model
+
+.. autoclass:: SwiftServiceModel
+    :members:
diff --git a/docs/api/models/swift/storage.rst b/docs/api/models/swift/storage.rst
@@ -0,0 +1,9 @@
+.. _swift_model_storage:
+
+Swift Storage Model
+===================
+
+.. currentmodule:: openstackinabox.models.swift.storage
+
+.. autoclass:: SwiftStorage
+    :members:
diff --git a/docs/api/services/base_service.rst b/docs/api/services/base_service.rst
@@ -0,0 +1,9 @@
+.. _base_service:
+
+Base Service
+============
+
+.. currentmodule:: openstackinabox.services.base_service
+
+.. autoclass:: BaseService
+    :members:
diff --git a/docs/api/services/cinder/index.rst b/docs/api/services/cinder/index.rst
@@ -0,0 +1,9 @@
+OpenStack Cinder Service
+========================
+
+.. currentmodule:: openstackinabox.services.cinder
+
+.. toctree::
+    :maxdepth: 2
+
+    v1/index
diff --git a/docs/api/services/cinder/v1/base.rst b/docs/api/services/cinder/v1/base.rst
@@ -0,0 +1,9 @@
+.. _cinder_v1_base:
+
+Cinder v1 Base Service
+======================
+
+.. currentmodule:: openstackinabox.services.cinder.v1.base
+
+.. autoclass:: CinderV1ServiceBase
+    :members:
diff --git a/docs/api/services/cinder/v1/index.rst b/docs/api/services/cinder/v1/index.rst
@@ -0,0 +1,10 @@
+OpenStack Cinder v1 Service
+===========================
+
+.. currentmodule:: openstackinabox.services.cinder.v1
+
+.. toctree::
+    :maxdepth: 2
+
+    base
+    volumes
diff --git a/docs/api/services/cinder/v1/volumes.rst b/docs/api/services/cinder/v1/volumes.rst
@@ -0,0 +1,9 @@
+.. _volumes:
+
+Cinder v1 Volumes
+=================
+
+.. currentmodule:: openstackinabox.services.cinder.v1.volumes
+
+.. autoclass:: CinderV1Volumes
+    :members:
diff --git a/docs/api/services/index.rst b/docs/api/services/index.rst
@@ -0,0 +1,12 @@
+OpenStack Services
+==================
+
+.. currentmodule:: openstackinabox.services
+
+.. toctree::
+    :maxdepth: 2
+
+    base_service
+    cinder/index
+    keystone/index
+    swift/index
diff --git a/docs/api/services/keystone/index.rst b/docs/api/services/keystone/index.rst
@@ -0,0 +1,9 @@
+OpenStack Keystone Services
+===========================
+
+.. currentmodule:: openstackinabox.services.keystone
+
+.. toctree::
+    :maxdepth: 2
+
+    v2/index
diff --git a/docs/api/services/keystone/v2/base.rst b/docs/api/services/keystone/v2/base.rst
@@ -0,0 +1,9 @@
+.. _keystone_v2_base:
+
+Keystone V2 Base Service
+========================
+
+.. currentmodule:: openstackinabox.services.keystone.v2.base
+
+.. autoclass:: KeystoneV2ServiceBase
+    :members: