Skip to content

RTD docs not building for quantify-scheduler only

This is an issue to track the current problem with the RTD docs.

It throws:

Running Sphinx v3.3.1
loading translations [en]... done

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/quantify-quantify-scheduler/envs/110/lib/python3.8/site-packages/sphinx/registry.py", line 416, in load_extension
    mod = import_module(extname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/quantify-quantify-scheduler/envs/110/lib/python3.8/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1014, in _gcd_import
  File "<frozen importlib._bootstrap>", line 991, in _find_and_load
  File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 671, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 783, in exec_module
  File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
  File "/home/docs/checkouts/readthedocs.org/user_builds/quantify-quantify-scheduler/envs/110/lib/python3.8/site-packages/enum_tools/autoenum.py", line 77, in <module>
    from sphinx_toolbox.more_autodoc.typehints import format_annotation  # nodep
  File "/home/docs/checkouts/readthedocs.org/user_builds/quantify-quantify-scheduler/envs/110/lib/python3.8/site-packages/sphinx_toolbox/__init__.py", line 33, in <module>
    from sphinx_toolbox import (  # noqa: F401
  File "/home/docs/checkouts/readthedocs.org/user_builds/quantify-quantify-scheduler/envs/110/lib/python3.8/site-packages/sphinx_toolbox/issues.py", line 128, in <module>
    import sphinx_toolbox.github.issues
  File "/home/docs/checkouts/readthedocs.org/user_builds/quantify-quantify-scheduler/envs/110/lib/python3.8/site-packages/sphinx_toolbox/github/__init__.py", line 186, in <module>
    from sphinx_toolbox.github.issues import (
  File "/home/docs/checkouts/readthedocs.org/user_builds/quantify-quantify-scheduler/envs/110/lib/python3.8/site-packages/sphinx_toolbox/github/issues.py", line 50, in <module>
    from sphinx_toolbox.cache import cache
  File "/home/docs/checkouts/readthedocs.org/user_builds/quantify-quantify-scheduler/envs/110/lib/python3.8/site-packages/sphinx_toolbox/cache.py", line 33, in <module>
    from apeye.rate_limiter import HTTPCache
  File "/home/docs/checkouts/readthedocs.org/user_builds/quantify-quantify-scheduler/envs/110/lib/python3.8/site-packages/apeye/rate_limiter.py", line 49, in <module>
    from cachecontrol import CacheControl, CacheControlAdapter  # type: ignore  # nodep
ModuleNotFoundError: No module named 'cachecontrol'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/quantify-quantify-scheduler/envs/110/lib/python3.8/site-packages/sphinx/cmd/build.py", line 276, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
  File "/home/docs/checkouts/readthedocs.org/user_builds/quantify-quantify-scheduler/envs/110/lib/python3.8/site-packages/sphinx/application.py", line 245, in __init__
    self.setup_extension(extension)
  File "/home/docs/checkouts/readthedocs.org/user_builds/quantify-quantify-scheduler/envs/110/lib/python3.8/site-packages/sphinx/application.py", line 402, in setup_extension
    self.registry.load_extension(self, extname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/quantify-quantify-scheduler/envs/110/lib/python3.8/site-packages/sphinx/registry.py", line 419, in load_extension
    raise ExtensionError(__('Could not import extension %s') % extname,
sphinx.errors.ExtensionError: Could not import extension enum_tools.autoenum (exception: No module named 'cachecontrol')

Extension error:
Could not import extension enum_tools.autoenum (exception: No module named 'cachecontrol')

NB quantify-core RTD is building correctly, though there the pip packages are not exactly the same.

Solution sees to just add cachecontrol to the requirements whatever the true problem is. Will follow up with a MR to test this

My guess: docs build uses outdated packages and some inconsistency arises there.

Edited by Victor Negîrneac