Skip to content

Commit

Permalink
yet another attempt to fix sphinx docs build: use sphinx >=2.4
Browse files Browse the repository at this point in the history
  • Loading branch information
snarfed committed Feb 24, 2020
1 parent 2886c82 commit 7b1d910
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@

# -- General configuration ------------------------------------------------

# [We specify Sphinx version with the docs extra in requirements.txt, and tell
# RTD to use it in .readthedocs.yaml. We *don't* use this, which doesn't
# actually tell RTD to use this version, it just fails if it doesn't match.]
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx~=2.4
15 changes: 6 additions & 9 deletions readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
# Config file for Sphinx build on ReadTheDocs:
# https://docs.readthedocs.io/en/latest/yaml-config.html
#
# extra_requirements is the important one. docs/conf.py configures sphinx to use
# autodoc, which generates docs from docstrings in code. It imports the code,
# which depends on the App Engine SDK.
# https://docs.readthedocs.io/en/stable/config-file/
# https://docs.readthedocs.io/en/stable/config-file/v2.html
version: 2
python:
setup_py_install: false
pip_install: true
extra_requirements:
- appengine-sdk
install:
- requirements: requirements.txt
- requirements: docs/requirements.txt

0 comments on commit 7b1d910

Please sign in to comment.