ionelmc / cookiecutter-pylibrary

Enhanced cookiecutter template for Python libraries.
BSD 2-Clause "Simplified" License
1.25k stars 207 forks source link

Add .readthedocs.yml config file to configure Read the Docs build. #177

Closed mfaafm closed 4 years ago

mfaafm commented 4 years ago

Adds a .readthedocs.yml config file, which configures the Read the Docs build. In the docs build, the package is installed using pip so the autodoc feature works. Since this config file overrides the advanced settings as configured in the UI, the user does not need to activate the virtualenv setting anymore.

The .readthedocs.yml is removed if cookiecutter.sphinx_docs == "no" or if "readthedocs" is not in cookiecutter.sphinx_docs_hosting.

Implements changes suggested by #176.

ionelmc commented 4 years ago

Looks good.