-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #480 from openedx/feanil/correct_docs_build
docs: Update the docs config which is very out of date.
- Loading branch information
Showing
2 changed files
with
21 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: | ||
# - 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters