Skip to content

Commit

Permalink
Update .readthedocs.yml (flashlight#1085)
Browse files Browse the repository at this point in the history
Summary:
Enable docs build with PRs on RTD. Update to use the new [build schema](https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os) and deprecate old properties. Python 3.10 (or something somewhat modern) is required for newer versions of Sphinx/Breathe.

Pull Request resolved: flashlight#1085

Test Plan: CI

Reviewed By: richjames0

Differential Revision: D44081047

Pulled By: jacobkahn

fbshipit-source-id: 5867451345de3593ff7c5153e1fdd182286c1678
  • Loading branch information
jacobkahn authored and facebook-github-bot committed Mar 15, 2023
1 parent 33753b9 commit afcd364
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,16 @@
# Required
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"

# Build documentation with Sphinx
sphinx:
configuration: docs/source/conf.py

# Python version and requirements for build
python:
version: 3.7
install:
- requirements: docs/requirements.txt

0 comments on commit afcd364

Please sign in to comment.