-
Notifications
You must be signed in to change notification settings - Fork 84
Closed
Labels
buggenerated-packageRelated to the generated package, i.e. after running cookiecutterRelated to the generated package, i.e. after running cookiecutter
Milestone
Description
The builds of the documentation on readthedocs.org fail with a ModuleNotFoundError
error. It would be nice if template would build the docs without problems.
Error is caused by a import of the package in the Sphinx configuration, see
import {{ cookiecutter.project_slug.lower().replace(' ', '_').replace('-', '_')}} |
This only succeeds when the package has been installed.
To have readthedocs.org build process also install the package you would need to put a .readthedocs.yaml file in the root of the repo filled with
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
python:
install:
- method: pip
path: .
Metadata
Metadata
Assignees
Labels
buggenerated-packageRelated to the generated package, i.e. after running cookiecutterRelated to the generated package, i.e. after running cookiecutter