From: Sebastian Wagner <sebastian.wagner@suse.com>
Date: Mon, 8 Jul 2019 08:29:58 +0000 (+0200)
Subject: python-common: Reference it in the docs
X-Git-Tag: v15.1.0~2025^2~6
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=c4625d86c42ea184ab54f7289d13f53b85a5c895;p=ceph.git

python-common: Reference it in the docs

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
---

diff --git a/doc/conf.py b/doc/conf.py
index fadb5248a86..19e2cf45b4b 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -106,6 +106,7 @@ class Mock(object):
 sys.modules['ceph_module'] = Mock()
 
 for pybind in [os.path.join(top_level, 'src/pybind'),
-               os.path.join(top_level, 'src/pybind/mgr')]:
+               os.path.join(top_level, 'src/pybind/mgr'),
+               os.path.join(top_level, 'src/python-common')]:
     if pybind not in sys.path:
         sys.path.insert(0, pybind)
diff --git a/doc/mgr/orchestrator_cli.rst b/doc/mgr/orchestrator_cli.rst
index 38684229b11..5138de05bb9 100644
--- a/doc/mgr/orchestrator_cli.rst
+++ b/doc/mgr/orchestrator_cli.rst
@@ -149,7 +149,8 @@ Create OSDs on a group of devices on a single host::
 
 The output of ``osd create`` is not specified and may vary between orchestrator backends.
 
-Where ``drive.group.json`` is a JSON file containing the fields defined in :class:`orchestrator.DriveGroupSpec`
+Where ``drive.group.json`` is a JSON file containing the fields defined in
+:class:`ceph.deployment_utils.drive_group.DriveGroupSpec`
 
 Example::
 
diff --git a/doc/mgr/orchestrator_modules.rst b/doc/mgr/orchestrator_modules.rst
index 6e6005718f5..77338660946 100644
--- a/doc/mgr/orchestrator_modules.rst
+++ b/doc/mgr/orchestrator_modules.rst
@@ -250,6 +250,8 @@ OSD management
 .. automethod:: Orchestrator.replace_osds
 .. automethod:: Orchestrator.remove_osds
 
+.. py:currentmodule:: ceph.deployment.drive_group
+
 .. autoclass:: DeviceSelection
    :members:
 
@@ -257,6 +259,8 @@ OSD management
    :members:
    :exclude-members: from_json
 
+.. py:currentmodule:: orchestrator
+
 Stateless Services
 ------------------
 
diff --git a/src/python-common/ceph/deployment/drive_group.py b/src/python-common/ceph/deployment/drive_group.py
index 74e005a5173..b77add82844 100644
--- a/src/python-common/ceph/deployment/drive_group.py
+++ b/src/python-common/ceph/deployment/drive_group.py
@@ -55,11 +55,6 @@ class DeviceSelection(object):
 
 
 class DriveGroupValidationError(Exception):
-    """
-    Defining an exception here is a bit problematic, cause you cannot properly catch it,
-    if it was raised in a different mgr module.
-    """
-
     def __init__(self, msg):
         super(DriveGroupValidationError, self).__init__('Failed to validate Drive Group: ' + msg)