django-wiki / django-nyt

Notification system for Django with batteries included: Email digests, user settings, JSON API
Apache License 2.0
144 stars 47 forks source link

Add .readthedocs.yaml #118

Closed benjaoming closed 1 year ago

benjaoming commented 1 year ago

Currently, our docs aren't building because we haven't configured anything. By default, Read the Docs uses old legacy tools when nothing is configured -- and that doesn't work.

Example: https://readthedocs.org/projects/django-nyt/builds/20372734/

oscarmcm commented 1 year ago

This might be what we need?

version: 2
build:
  os: ubuntu-20.04
  tools:
    python: "3.9"
sphinx:
   configuration: docs/conf.py
python:
   install:
    - method: pip
      path: .
      extra_requirements:
        - docs
benjaoming commented 1 year ago

Yes, I think that's good :+1: