Skip to content

Project Not Building on readthedocs.org (config.py.tmpl?) #7704

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

Closed
hysz opened this issue Nov 27, 2020 · 2 comments
Closed

Project Not Building on readthedocs.org (config.py.tmpl?) #7704

hysz opened this issue Nov 27, 2020 · 2 comments

Comments

@hysz
Copy link

hysz commented Nov 27, 2020

Details

This afternoon my project stopped building on readthedocs.org. It works locally.

Expected Result

The project builds.

Actual Result

The project fails to build with the error: ModuleNotFoundError: No module named 'six'. This error seems to be coming from config.py.tmpl.

@hysz
Copy link
Author

hysz commented Nov 28, 2020

This workaround worked for me:

  1. Created a .readthedocs.yaml:
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
  configuration: docs/conf.py

# Build documentation with MkDocs
#mkdocs:
#  configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF
#formats:
#  - pdf

# Optionally set the version of Python and requirements required to build your docs
python:
  version: 3.7
  install:
    - requirements: docs/requirements.txt
  1. Created a docs/requirements.txt file:
six

Although I'll leave this open, as it seems that this dependency should be getting installed automatically (and I believe was previously, since I have never had this issue before).

@humitos
Copy link
Member

humitos commented Nov 30, 2020

I'm closing this one as duplicated of #7705

Please, subscribe there for updates. Thanks for reporting!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants