From 1ea028e8472d3cffb8689383e5d9b1169ad08be6 Mon Sep 17 00:00:00 2001 From: Timo Cornelius Metzger <39711796+tcmetzger@users.noreply.github.com> Date: Tue, 23 Apr 2024 08:53:13 -0700 Subject: [PATCH] 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 --- .readthedocs.yml | 10 +++++++--- docs/docs-requirements.txt | 17 +++++++++++++++++ docs/source/conf.py | 1 - 3 files changed, 24 insertions(+), 4 deletions(-) create mode 100644 docs/docs-requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml index 339c944d..e677d36d 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -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: @@ -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] diff --git a/docs/docs-requirements.txt b/docs/docs-requirements.txt new file mode 100644 index 00000000..a8fde6b1 --- /dev/null +++ b/docs/docs-requirements.txt @@ -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 diff --git a/docs/source/conf.py b/docs/source/conf.py index d7f91476..3ea3a164 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -44,7 +44,6 @@ 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', 'sphinx.ext.autosummary', - 'sphinx_multiversion', 'nbsphinx', 'sphinx.ext.mathjax', 'matplotlib.sphinxext.plot_directive',