diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f4ad9d82..34040cef 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,17 +1,29 @@ -# .readthedocs.yaml +# .readthedocs.yml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details -# Required +# Required: the version of this file's schema. version: 2 # Build documentation in the docs/ directory with Sphinx sphinx: - configuration: docs/conf.py - # TODO: Fix autodoc warnings and set this to true. See https://github.com/openedx/edx-django-utils/issues/304 - fail_on_warning: false + configuration: docs/conf.py + # fail_on_warning: true +# Optionally build your docs in additional formats such as PDF +# formats: +# - pdf +# - epub + +# Set the version of python needed to build these docs. +build: + os: "ubuntu-lts-latest" + tools: + python: "3.12" + apt_packages: + - graphviz + +# Optionally set the requirements required to build your docs python: - version: 3.8 - install: - - requirements: requirements/doc.txt + install: + - requirements: requirements/doc.txt diff --git a/docs/conf.py b/docs/conf.py index 8a7e5c62..c6d9f513 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -111,7 +111,7 @@ def get_version(*file_paths): # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: