python-common: Reference it in the docs

Signed-off-by: Sebastian Wagner <[email protected]>

Author: sebastian-philipp

doc/conf.py

@@ -106,6 +106,7 @@ def __getattr__(cls, name):
 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)

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::
 

doc/mgr/orchestrator_modules.rst

@@ -250,13 +250,17 @@ OSD management
 .. automethod:: Orchestrator.replace_osds
 .. automethod:: Orchestrator.remove_osds
 
+.. py:currentmodule:: ceph.deployment.drive_group
+
 .. autoclass:: DeviceSelection
    :members:
 
 .. autoclass:: DriveGroupSpec
    :members:
    :exclude-members: from_json
 
+.. py:currentmodule:: orchestrator
+
 Stateless Services
 ------------------
 

src/python-common/ceph/deployment/drive_group.py

@@ -55,11 +55,6 @@ def from_json(cls, device_spec):
 
 
 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)