Skip to content

Commit

Permalink
fix: update documentation build dependencies (#433)
Browse files Browse the repository at this point in the history

Signed-off-by: ThibaultFy <[email protected]>
  • Loading branch information
ThibaultFy authored Jul 30, 2024
1 parent 12f004d commit e04f5e5
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 16 deletions.
18 changes: 10 additions & 8 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,18 @@
# Required
version: 2

build:
os: "ubuntu-22.04"
tools:
python: "miniconda3-4.7"
jobs:
pre_create_environment:
- conda update --yes --quiet --name=base --channel=defaults conda
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py
fail_on_warning: True
fail_on_warning: False

# Optionally build your docs in additional formats such as PDF
formats: []
conda:
environment: docs/environment.yml

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.8
install:
- requirements: requirements.txt
6 changes: 3 additions & 3 deletions docs/requirements.txt → docs/doc-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
recommonmark==0.6.0
sphinx==4.4.0
sphinx==5.3.0
sphinx-markdown-tables==0.0.12
sphinx-rtd-theme==0.5.1
sphinx-autobuild==2020.9.1
sphinx_click==3.1.0
click==7.1.2
click==8
texttable==1.6.3
myst-parser==0.16.1
myst-parser==0.18.1
# Sphinx 3.3.1 does not require a specific version of docutils
# but docutils 0.17 changed the output html markup, breaking the RTD theme
# original issue: https://github.com/sphinx-doc/sphinx/issues/9051
Expand Down
9 changes: 9 additions & 0 deletions docs/environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: rtd
channels:
- defaults
- conda-forge
dependencies:
- python=3.10
- pip
- pip:
- -r ../requirements.txt
8 changes: 4 additions & 4 deletions examples_requirements.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
matplotlib==3.6.3
scikit-learn==1.1.1
scikit-learn==1.5.1
pandas==1.5.3
# Dependencies for the SubstraFL FedAvg example on MNIST dataset
torch==1.13.1
torchvision==0.14.1
numpy==1.23.1
torch==2.3.1
torchvision==0.18.1
numpy==1.26.4
gitpython==3.1.30
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
-r docs/requirements.txt
-r docs/doc-requirements.txt
-r examples_requirements.txt

0 comments on commit e04f5e5

Please sign in to comment.