Skip to content

Commit

Permalink
Update readthedocs configuration (#798)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
tcmetzger and brendancol authored Apr 23, 2024
1 parent 61e187c commit 1ea028e
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 4 deletions.
10 changes: 7 additions & 3 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ build:
os: ubuntu-22.04
tools:
python: "3.12"
jobs:
pre_build:
- pip install '.[doc,tests]'

# Build documentation in the "docs/" directory with Sphinx
sphinx:
Expand All @@ -19,8 +22,9 @@ sphinx:
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
install:
# - requirements: docs/docs-requirements.txt
- method: pip
path: .
extra_requirements:
- [doc, tests]
# extra_requirements:
# - [doc, tests]
17 changes: 17 additions & 0 deletions docs/docs-requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
dask[dataframe]
geopandas
Jinja2 >=2.11
ipykernel
matplotlib
nbsphinx
numpydoc
pandoc
pydata_sphinx_theme
sphinx
sphinx-panels
sphinx_rtd_theme
flake8
isort
noise >= 1.2.2
pytest
pytest-cov
1 change: 0 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'sphinx.ext.autosummary',
'sphinx_multiversion',
'nbsphinx',
'sphinx.ext.mathjax',
'matplotlib.sphinxext.plot_directive',
Expand Down

0 comments on commit 1ea028e

Please sign in to comment.