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 documentation builds #914

Merged
merged 13 commits into from
Feb 26, 2024
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
14 changes: 5 additions & 9 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,12 @@ build:
python: "3.11"
rust: "1.64"
jobs:
post_create_environment:
# Install poetry
# https://python-poetry.org/docs/#installing-manually
- pip install poetry
# Tell poetry to not use a virtual environment
- poetry config virtualenvs.create false
post_install:
# Install dependencies with 'docs' dependency group
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
- poetry install --with=docs
# This is copied from the poetry config - not great but just could not get it working otherwise
- pip install sphinx==6.1.3
- pip install sphinxcontrib-spelling==8.0.0
- pip install sphinx-immaterial==0.11.10
- pip install pyenchant==3.2.2

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ smtpdfix = "^0.5.1"
httpx = "^0.24.0"

[tool.poetry.group.docs.dependencies]
# Also in readthedocs.yaml
sphinx = "^6.1.3"
sphinxcontrib-spelling = "^8.0.0"
sphinx-immaterial = "^0.11.10"
Expand Down