Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Fix failing rtd build #15

Merged
merged 7 commits into from
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,11 @@ python:
sphinx:
configuration: docs/source/conf.py
fail_on_warning: true

# Install the documentation dependencies with pip when building on readthedocs
python:
install:
- method: pip
path: .
extra_requirements:
- docs
8 changes: 0 additions & 8 deletions docs/requirements.txt

This file was deleted.

17 changes: 17 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,26 @@ dependencies = [


[project.optional-dependencies]

docs = [
"astroid>=3", # RTD issue https://github.com/readthedocs/readthedocs.org/issues/11975
"sphinx>=7.3.7",
"sphinx-autoapi>=3.3.3",
"sphinx-rtd-theme>=1.3.0rc1",
"ipykernel>=6.29.5",
# To build locally, pandoc must also be installed locally for nbsphinx
# https://pandoc.org/installing.html
# May require a computer restart (at least on Windows)
"nbsphinx>=0.9.5",
]

tests = [
"pytest >= 8.3.1",
]




[tool.setuptools.packages.find]
where = ["src"]

Expand All @@ -50,6 +66,7 @@ where = ["src"]
skip = '*.ipynb'
# Add false positives found by codespell to ignore-words-list
ignore-words-list = """
astroid,
hax,
vax"""

Expand Down