Skip to content

Commit

Permalink
Fix failing docs build (#93)
Browse files Browse the repository at this point in the history
* Organize file to match template on readthedocs.io

See https://docs.readthedocs.io/en/stable/config-file/index.html

* Remove obsolete system_packages key

* Add news fragment
  • Loading branch information
mdpiper authored Mar 15, 2024
1 parent 1599243 commit 51fb527
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
20 changes: 8 additions & 12 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,25 +1,21 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"
jobs:
pre_build:
- sphinx-apidoc -e -force --no-toc --module-first -o docs/source/api babelizer

sphinx:
builder: html
configuration: docs/source/conf.py
fail_on_warning: false

formats:
- htmlzip

python:
install:
- requirements: requirements-docs.txt
- requirements: requirements.txt
- method: pip
path: .
system_packages: false

build:
os: ubuntu-22.04
tools:
python: "3.9"
jobs:
pre_build:
- sphinx-apidoc -e -force --no-toc --module-first -o docs/source/api babelizer
3 changes: 3 additions & 0 deletions news/93.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@

Removed the the now-obsolete `system_packages` configuration key that was
causing builds to fail on rtfd.io.

0 comments on commit 51fb527

Please sign in to comment.