Commit 4d58c7a7 authored by Vincent POLLET's avatar Vincent POLLET
Browse files

[DOC] Fix to tackle sphinx issues of packages importing bob.ip.stereo (and not...

[DOC] Fix to tackle sphinx issues of packages importing bob.ip.stereo (and not finding members imported in __init__
parent 1602c2ec
#from . import script, config
from .stereo import stereo_match, reproject_image
from .camera import load_camera_config, Camera, CameraPair
from .parameters import StereoParameters
# gets sphinx autodoc done right - don't remove it
def __appropriate__(*args):
"""Says object was actually declared here, and not in the import module.
Fixing sphinx warnings of not being able to find classes, when path is
shortened.
Resolves `Sphinx referencing issues
<https://github.com/sphinx-doc/sphinx/issues/3048>`
Parameters
----------
*args
An iterable of objects to modify.
"""
for obj in args:
obj.__module__ = __name__
__appropriate__(
stereo_match,
reproject_image,
load_camera_config,
Camera,
CameraPair,
StereoParameters
)
def get_config():
"""Returns a string containing the configuration information.
"""
"""Returns a string containing the configuration information.
"""
import bob.extension
return bob.extension.get_config(__name__)
import bob.extension
return bob.extension.get_config(__name__)
# gets sphinx autodoc done right - don't remove it
__all__ = [_ for _ in dir() if not _.startswith('_')]
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment