add missing [docs] dependencies, pin sphinx to a new version, point readthedocs to a .[docs] installation

This commit is contained in:
jdegenstein 2025-01-14 13:02:09 -06:00
parent d567380bd9
commit 2559262fff
3 changed files with 13 additions and 3 deletions

View file

@ -15,7 +15,14 @@ build:
sphinx:
configuration: docs/conf.py
# Explicitly set the version of Python and its requirements
python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .
extra_requirements:
- docs
# Explicitly set the version of Python and its requirements
# python:
# install:
# - requirements: docs/requirements.txt

View file

@ -1,3 +1,4 @@
# TODO: delete this file as it is no longer used to build the docs
# Defining the exact version will make sure things don't break
sphinx==5.3.0
sphinx_rtd_theme>=0.5.1

View file

@ -75,10 +75,12 @@ benchmark = [
# dependencies to build the docs
docs = [
"sphinx",
"sphinx==8.1.3", # pin for stability of docs builds
"sphinx-design",
"sphinx-copybutton",
"sphinx-hoverxref",
"sphinx-rtd-theme",
"sphinx_autodoc_typehints",
]
# all dependencies