Skip to content
Merged
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
29 changes: 29 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: docs

on:
pull_request:
push:
branches: [main, master]

jobs:
build-docs:
name: Build documentation
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .
pip install -r docs/requirements.txt
Comment on lines +22 to +26

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Ensure PyTorch is installed from the proper index

The docs workflow installs the project via pip install ., which pulls in the mandatory torch dependency. In the existing CI workflow, PyTorch is installed separately using pip install torch --index-url https://download.pytorch.org/whl/cpu because the wheels are not published on the default PyPI index. Without that override, pip install . cannot resolve torch and the docs job will fail before mkdocs build runs. The step should install PyTorch from the same index or otherwise avoid the dependency to make the workflow reliable.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mark this for now, comeback to this if anything happens


- name: Build site
run: mkdocs build --strict