resolve errors building sphinx documentation

[prjemian]

• FIX errors when building the Sphinx documentation #588

[prjemian]

Still, multiples of this error:

ValueError: The container <class 'databroker.core.RemoteBlueskyRun'> could not be registered for the name bluesky-run because <class 'databroker.core.RemoteBlueskyRun'> is already registered for that name. Use overwrite=True to force it.

WARNING: autodoc: failed to import module '_devices.struck3820' from module 'apstools'; the following exception was raised:
Traceback (most recent call last):
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/sphinx/ext/autodoc/importer.py", line 70, in import_module
    return importlib.import_module(modname)
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1030, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1007, in _find_and_load
  File "<frozen importlib._bootstrap>", line 986, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 680, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 850, in exec_module
  File "<frozen importlib._bootstrap>", line 228, in _call_with_frames_removed
  File "/home/prjemian/Documents/projects/BCDA-APS/apstools/apstools/_devices/__init__.py", line 72, in <module>
    from .kohzu_monochromator import KohzuSeqCtl_Monochromator
  File "/home/prjemian/Documents/projects/BCDA-APS/apstools/apstools/_devices/kohzu_monochromator.py", line 20, in <module>
    from ..utils import run_in_thread
  File "/home/prjemian/Documents/projects/BCDA-APS/apstools/apstools/utils.py", line 129, in <module>
    import databroker
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/databroker/__init__.py", line 22, in <module>
    catalog = MergedCatalog([
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/local.py", line 833, in __init__
    super().__init__(*args, **kwargs)
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/base.py", line 101, in __init__
    self.force_reload()
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/base.py", line 159, in force_reload
    self._load()
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/local.py", line 837, in _load
    catalog._load()
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/local.py", line 810, in _load
    entry.reload()
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/base.py", line 164, in reload
    self.force_reload()
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/base.py", line 159, in force_reload
    self._load()
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/local.py", line 608, in _load
    self.parse(text)
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/local.py", line 684, in parse
    result = CatalogParser(data, context=context, getenv=self.getenv,
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/local.py", line 318, in __init__
    self._data = self._parse(data)
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/local.py", line 520, in _parse
    data_sources=self._parse_data_sources(data),
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/local.py", line 507, in _parse_data_sources
    obj = self._parse_data_source(name, source)
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/local.py", line 432, in _parse_data_source
    return self._parse_data_source_local(name, data)
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/local.py", line 477, in _parse_data_source_local
    return LocalCatalogEntry(catalog_dir=self._context['root'],
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/catalog/local.py", line 185, in __init__
    dr = get_plugin_class(driver)
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/source/__init__.py", line 103, in get_plugin_class
    if name in registry:
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/_collections_abc.py", line 769, in __contains__
    self[key]
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/utils.py", line 206, in __getitem__
    return self._registry[key]
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/source/__init__.py", line 26, in __getitem__
    self[item] = super().__getitem__(item).load()
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/entrypoints.py", line 82, in load
    mod = import_module(self.module_name)
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/databroker/_drivers/mongo_normalized.py", line 10, in <module>
    from ..core import to_event_pages, to_datum_pages, Entry
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/databroker/core.py", line 1956, in <module>
    intake.container.register_container('bluesky-run', RemoteBlueskyRun)
  File "/home/prjemian/.conda/envs/bluesky_2022_1/lib/python3.9/site-packages/intake/container/__init__.py", line 50, in register_container
    raise ValueError(
ValueError: The container <class 'databroker.core.RemoteBlueskyRun'> could not be registered for the name bluesky-run because <class 'databroker.core.RemoteBlueskyRun'> is already registered for that name. Use overwrite=True to force it.

[prjemian]

Note, same result with databroker v1.1.0, v1.2.3, v1.2.4 (latest).

[prjemian]

Local docs build with no errors but workflow still shows errors. Need to install more packages into documentation workflow? Or Mock?

[prjemian]

Finally, no more import problems when building the documentation in the workflow.