datalad / datalad-extension-template

Minimal implementation of a DataLad extension module
http://datalad.org
Other
2 stars 17 forks source link

Add `.readthedocs.yaml` #60

Closed mih closed 1 year ago

mih commented 1 year ago

ReadTheDocs:

Configuration files will soon be required by projects, and will no longer be optional. Read our blog post to create one and ensure your project continues building successfully. https://blog.readthedocs.com/migrate-configuration-v2/

Support for the previous method of configuring via thew webUI will end soon:

Usage of the below settings is deprecated and support for these fields will be removed on September 25th, 2023.

Docs: https://docs.readthedocs.io/en/stable/config-file/v2.html

Example:

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

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.11"
    # You can also specify other tool versions:
    # nodejs: "19"
    # rust: "1.64"
    # golang: "1.19"

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

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

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
#    install:
#    - requirements: docs/requirements.txt