Skip to content

Commit

Permalink
Merge pull request #480 from openedx/feanil/correct_docs_build
Browse files Browse the repository at this point in the history
docs: Update the docs config which is very out of date.
  • Loading branch information
feanil authored Feb 10, 2025
2 parents 9a39cd3 + 6a71ebe commit 7755284
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 9 deletions.
28 changes: 20 additions & 8 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 7755284

Please sign in to comment.