Skip to content

Commit 1ea028e

Browse files
tcmetzgerbrendancol
andauthoredApr 23, 2024··
Update readthedocs configuration (#798)
* temporarily use requirements.txt * update requirements * update conf.py * Test different approach for dependency install * next attempt --------- Co-authored-by: Brendan Collins <brendan@makepath.com>
1 parent 61e187c commit 1ea028e

File tree

3 files changed

+24
-4
lines changed

3 files changed

+24
-4
lines changed
 

‎.readthedocs.yml

+7-3
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ build:
1010
os: ubuntu-22.04
1111
tools:
1212
python: "3.12"
13+
jobs:
14+
pre_build:
15+
- pip install '.[doc,tests]'
1316

1417
# Build documentation in the "docs/" directory with Sphinx
1518
sphinx:
@@ -19,8 +22,9 @@ sphinx:
1922
# to build your documentation
2023
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
2124
python:
22-
install:
25+
install:
26+
# - requirements: docs/docs-requirements.txt
2327
- method: pip
2428
path: .
25-
extra_requirements:
26-
- [doc, tests]
29+
# extra_requirements:
30+
# - [doc, tests]

‎docs/docs-requirements.txt

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
dask[dataframe]
2+
geopandas
3+
Jinja2 >=2.11
4+
ipykernel
5+
matplotlib
6+
nbsphinx
7+
numpydoc
8+
pandoc
9+
pydata_sphinx_theme
10+
sphinx
11+
sphinx-panels
12+
sphinx_rtd_theme
13+
flake8
14+
isort
15+
noise >= 1.2.2
16+
pytest
17+
pytest-cov

‎docs/source/conf.py

-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@
4444
'sphinx.ext.napoleon',
4545
'sphinx.ext.viewcode',
4646
'sphinx.ext.autosummary',
47-
'sphinx_multiversion',
4847
'nbsphinx',
4948
'sphinx.ext.mathjax',
5049
'matplotlib.sphinxext.plot_directive',

0 commit comments

Comments
 (0)
Please sign in to comment.