Skip to content

Commit e04f5e5

Browse files
authored
fix: update documentation build dependencies (#433)
Signed-off-by: ThibaultFy <thibault.fouqueray@gmail.com>
1 parent 12f004d commit e04f5e5

5 files changed

Lines changed: 27 additions & 16 deletions

File tree

.readthedocs.yaml

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,18 @@
55
# Required
66
version: 2
77

8+
build:
9+
os: "ubuntu-22.04"
10+
tools:
11+
python: "miniconda3-4.7"
12+
jobs:
13+
pre_create_environment:
14+
- conda update --yes --quiet --name=base --channel=defaults conda
815
# Build documentation in the docs/ directory with Sphinx
916
sphinx:
1017
configuration: docs/source/conf.py
11-
fail_on_warning: True
18+
fail_on_warning: False
1219

13-
# Optionally build your docs in additional formats such as PDF
14-
formats: []
20+
conda:
21+
environment: docs/environment.yml
1522

16-
# Optionally set the version of Python and requirements required to build your docs
17-
python:
18-
version: 3.8
19-
install:
20-
- requirements: requirements.txt
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
recommonmark==0.6.0
2-
sphinx==4.4.0
2+
sphinx==5.3.0
33
sphinx-markdown-tables==0.0.12
44
sphinx-rtd-theme==0.5.1
55
sphinx-autobuild==2020.9.1
66
sphinx_click==3.1.0
7-
click==7.1.2
7+
click==8
88
texttable==1.6.3
9-
myst-parser==0.16.1
9+
myst-parser==0.18.1
1010
# Sphinx 3.3.1 does not require a specific version of docutils
1111
# but docutils 0.17 changed the output html markup, breaking the RTD theme
1212
# original issue: https://github.com/sphinx-doc/sphinx/issues/9051

docs/environment.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name: rtd
2+
channels:
3+
- defaults
4+
- conda-forge
5+
dependencies:
6+
- python=3.10
7+
- pip
8+
- pip:
9+
- -r ../requirements.txt

examples_requirements.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
matplotlib==3.6.3
2-
scikit-learn==1.1.1
2+
scikit-learn==1.5.1
33
pandas==1.5.3
44
# Dependencies for the SubstraFL FedAvg example on MNIST dataset
5-
torch==1.13.1
6-
torchvision==0.14.1
7-
numpy==1.23.1
5+
torch==2.3.1
6+
torchvision==0.18.1
7+
numpy==1.26.4
88
gitpython==3.1.30

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
-r docs/requirements.txt
1+
-r docs/doc-requirements.txt
22
-r examples_requirements.txt

0 commit comments

Comments
 (0)