Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs currently fail to build on readthedocs #320

Closed
dotsdl opened this issue Oct 25, 2024 · 1 comment
Closed

Docs currently fail to build on readthedocs #320

dotsdl opened this issue Oct 25, 2024 · 1 comment
Assignees

Comments

@dotsdl
Copy link
Member

dotsdl commented Oct 25, 2024

We are getting sphinx build errors that only showed up a few days ago, for example: https://readthedocs.org/projects/alchemiscale/builds/26073534/

They look like this:

Running Sphinx v5.3.0

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/alchemiscale/conda/280/lib/python3.13/site-packages/sphinx/registry.py", line 459, in load_extension
    mod = import_module(extname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/alchemiscale/conda/280/lib/python3.13/importlib/__init__.py", line 88, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1387, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1360, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 935, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 1022, in exec_module
  File "<frozen importlib._bootstrap>", line 488, in _call_with_frames_removed
  File "/home/docs/checkouts/readthedocs.org/user_builds/alchemiscale/conda/280/lib/python3.13/site-packages/sphinx/builders/epub3.py", line 12, in <module>
    from sphinx.builders import _epub_base
  File "/home/docs/checkouts/readthedocs.org/user_builds/alchemiscale/conda/280/lib/python3.13/site-packages/sphinx/builders/_epub_base.py", line 16, in <module>
    from sphinx.builders.html import BuildInfo, StandaloneHTMLBuilder
  File "/home/docs/checkouts/readthedocs.org/user_builds/alchemiscale/conda/280/lib/python3.13/site-packages/sphinx/builders/html/__init__.py", line 46, in <module>
    from sphinx.writers.html import HTMLTranslator, HTMLWriter
  File "/home/docs/checkouts/readthedocs.org/user_builds/alchemiscale/conda/280/lib/python3.13/site-packages/sphinx/writers/html.py", line 21, in <module>
    from sphinx.util.images import get_image_size
  File "/home/docs/checkouts/readthedocs.org/user_builds/alchemiscale/conda/280/lib/python3.13/site-packages/sphinx/util/images.py", line 4, in <module>
    import imghdr
ModuleNotFoundError: No module named 'imghdr'

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

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/alchemiscale/conda/280/lib/python3.13/site-packages/sphinx/cmd/build.py", line 276, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
                 args.doctreedir, args.builder, args.confoverrides, args.status,
                 args.warning, args.freshenv, args.warningiserror,
                 args.tags, args.verbosity, args.jobs, args.keep_going,
                 args.pdb)
  File "/home/docs/checkouts/readthedocs.org/user_builds/alchemiscale/conda/280/lib/python3.13/site-packages/sphinx/application.py", line 219, in __init__
    self.setup_extension(extension)
    ~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/alchemiscale/conda/280/lib/python3.13/site-packages/sphinx/application.py", line 398, in setup_extension
    self.registry.load_extension(self, extname)
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/alchemiscale/conda/280/lib/python3.13/site-packages/sphinx/registry.py", line 462, in load_extension
    raise ExtensionError(__('Could not import extension %s') % extname,
                         err) from err
sphinx.errors.ExtensionError: Could not import extension sphinx.builders.epub3 (exception: No module named 'imghdr')

Extension error:
Could not import extension sphinx.builders.epub3 (exception: No module named 'imghdr')

We are using an old version of sphinx in our doc build environment, so perhaps it's time to upgrade? I don't recall the specifics, but I believe there was a reason we remained on sphinx 5.x.

@dotsdl
Copy link
Member Author

dotsdl commented Nov 12, 2024

Closed by #325.

@dotsdl dotsdl closed this as completed Nov 12, 2024
@github-project-automation github-project-automation bot moved this from Sprint - Available to Done in alchemiscale : advancement sprints Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

2 participants