Skip to content

Commit

Permalink
build: configure readthedocs to refresh stale documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
parthea committed Jan 29, 2025
1 parent ca82184 commit a87dd1c
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
22 changes: 22 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version, and other tools you might need
build:
os: ubuntu-24.04
tools:
python: "3.13"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py

python:
install:
- requirements: docs/requirements-docs.txt
# Install our python package before building the docs
- method: pip
path: .
14 changes: 13 additions & 1 deletion docs/requirements-docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,16 @@ cryptography
sphinx-docstring-typing
urllib3
requests
requests-oauthlib
requests-oauthlib
# We need to pin to specific versions of the `sphinxcontrib-*` packages
# which still support sphinx 4.x.
# See https://github.com/googleapis/sphinx-docfx-yaml/issues/344
# and https://github.com/googleapis/sphinx-docfx-yaml/issues/345.
sphinxcontrib-applehelp==1.0.4
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
sphinx==4.5.0
alabaster
recommonmark

0 comments on commit a87dd1c

Please sign in to comment.