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 readthedocs sphinx build #23

Merged
merged 2 commits into from
Jul 18, 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
16 changes: 0 additions & 16 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,3 @@ jobs:
run: |
chmod og-rw ~
pytest --cov aiida_hyperqueue --cov-append .

docs:
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- uses: actions/checkout@v3
- name: Set up Python 3.10
uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install python dependencies
run: |
pip install --upgrade pip
pip install .[docs]
- name: Build docs
run: cd docs && make
30 changes: 23 additions & 7 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,25 @@
version: 2

python:
version: 3.10
install:
- method: pip
path: .
extra_requirements:
- docs
# YAML adapted from aiida-core .readthedocs.yml

# Disable all unneeded formats
formats: []

build:
os: ubuntu-22.04
tools:
python: '3.11'
jobs:
# Use uv to speed up the build
# https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-uv
post_create_environment:
- asdf plugin add uv
- asdf install uv 0.2.9
- asdf global uv 0.2.9
post_install:
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv pip install .[docs]

# Let the build fail if there are any warnings
sphinx:
builder: html
fail_on_warning: true
Loading