Skip to content
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
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,6 @@ mypy .
pytest

# Build docs
pip install -e .[docs] && make -C docs html
pip install -r requirements-docs.txt && make -C docs html

-->
3 changes: 2 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,14 @@ jobs:
sudo rm -rf /var/lib/apt/lists/*

- name: Install documentation dependencies
working-directory: docs
run: |
df -h
python -m pip install --upgrade pip
df -h
pip install --index-url https://download.pytorch.org/whl/cpu "torch>=2.0.0,<=2.10.0"
df -h
pip install -e ".[docs]"
pip install -r requirements.txt
df -h

- name: Build documentation
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ pip install -e '.[examples]'

Build documentation locally:
```bash
pip install -e '.[docs]'
pip install -r requirements-docs.txt
cd docs
make html # or: make livehtml (if sphinx-autobuild added manually)
```
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
-e ..[docs]
-r ../requirements-docs-vcs.txt
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ docs = [
"ipykernel",
"gitpython",
"python-dotenv",
"sphinx-multiversion-contrib @ git+https://github.com/Quandela/sphinx-multiversion-contrib.git@1.1.1",
"jinja2==3.0.0",
"scikit-learn>=1.7.0",
]
Expand Down
1 change: 1 addition & 0 deletions requirements-docs-vcs.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx-multiversion-contrib @ git+https://github.com/Quandela/sphinx-multiversion-contrib.git@1.1.1
1 change: 1 addition & 0 deletions requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
-e .[docs]
-r requirements-docs-vcs.txt
Loading