Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Readthedocs needs config for install #78

Copy link
Copy link
@sverhoeven

Description

@sverhoeven
Issue body actions

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

No one assigned

    Labels

    buggenerated-packageRelated to the generated package, i.e. after running cookiecutterRelated to the generated package, i.e. after running cookiecutter

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.