Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update readthedocs configuration [WIP] #798

Merged
merged 6 commits into from
Apr 23, 2024
Merged

Update readthedocs configuration [WIP] #798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b943acb
temporarily use requirements.txt
tcmetzger Apr 23, 2024
b8578a8
Merge branch 'master' into update_readthedocs_config
brendancol Apr 23, 2024
408d1ab
update requirements
tcmetzger Apr 23, 2024
3960893
update conf.py
tcmetzger Apr 23, 2024
f8642fd
Test different approach for dependency install
tcmetzger Apr 23, 2024
0146ec4
next attempt
tcmetzger Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions .readthedocs.yml
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading