readthedocs / readthedocs.org

The source code that powers readthedocs.org
https://readthedocs.org/
MIT License
8.05k stars 3.59k forks source link

Tutorial project produces "WARNING: [autosummary] failed to import lumache" #11699

Closed LarrySnyder closed 4 weeks ago

LarrySnyder commented 1 month ago

Details

Expected Result

Tutorial project builds without errors/warnings, pages render correctly

Actual Result

Got WARNING: [autosummary] failed to import lumache, ModuleNotFoundError: No module named 'lumache', and related warnings/errors. Also, API page is blank, and autofunction does not render on usage page.

Screenshot 2024-10-19 at 1 33 07 PM Screenshot 2024-10-19 at 1 32 31 PM

Steps to Reproduce

  1. Go to tutorial template, click "Use this template" > "Create a new repository".
  2. Enter repo name (I used rtd-tutorial-LVS4), leave other settings at default values, click "Create repository".
  3. Go to RTD dashboard, click "Import a Project", click "+" next to the repo, accept defaults, click "Next". (Build triggers automatically.)
  4. Go to Builds page, open the build, "View raw". Log contains:
[rtd-command-info] start-time: 2024-10-19T17:22:14.871854Z, end-time: 2024-10-19T17:22:16.045951Z, duration: 1, exit-code: 0
python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
Running Sphinx v7.1.2
making output directory... done
[autosummary] generating autosummary for: api.rst, index.rst, usage.rst
WARNING: [autosummary] failed to import lumache.
Possible hints:
* ModuleNotFoundError: No module named 'lumache'
* KeyError: 'lumache'
* ValueError: not enough values to unpack (expected 2, got 1)
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://www.sphinx-doc.org/en/master/objects.inv...
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 3 source files that are out of date
updating environment: [new config] 3 added, 0 changed, 0 removed
reading sources... [ 33%] api
reading sources... [ 67%] index
reading sources... [100%] usage
/home/docs/checkouts/readthedocs.org/user_builds/rtd-tutorial-lvs4/checkouts/latest/docs/source/api.rst:4: WARNING: autosummary: failed to import lumache.
Possible hints:
* ModuleNotFoundError: No module named 'lumache'
* KeyError: 'lumache'
* ValueError: not enough values to unpack (expected 2, got 1)
WARNING: autodoc: failed to import function 'get_random_ingredients' from module 'lumache'; the following exception was raised:
No module named 'lumache'
WARNING: autodoc: failed to import exception 'InvalidKindError' from module 'lumache'; the following exception was raised:
No module named 'lumache'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [ 33%] api
writing output... [ 67%] index
writing output... [100%] usage
generating indices... genindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
stsewd commented 4 weeks ago

Hi, this is part of the tutorial, see https://docs.readthedocs.io/en/stable/tutorial/#making-build-warnings-more-visible.

LarrySnyder commented 3 weeks ago

Oof, sorry about that!