From e04f5e59753229e7c6aac0df38a39fdbd789fa96 Mon Sep 17 00:00:00 2001 From: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com> Date: Tue, 30 Jul 2024 14:48:55 +0200 Subject: [PATCH] fix: update documentation build dependencies (#433) Signed-off-by: ThibaultFy --- .readthedocs.yaml | 18 ++++++++++-------- .../{requirements.txt => doc-requirements.txt} | 6 +++--- docs/environment.yml | 9 +++++++++ examples_requirements.txt | 8 ++++---- requirements.txt | 2 +- 5 files changed, 27 insertions(+), 16 deletions(-) rename docs/{requirements.txt => doc-requirements.txt} (90%) create mode 100644 docs/environment.yml diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 41da2b90b..f1da1a566 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -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 diff --git a/docs/requirements.txt b/docs/doc-requirements.txt similarity index 90% rename from docs/requirements.txt rename to docs/doc-requirements.txt index 3c82e0d90..38674ed3c 100644 --- a/docs/requirements.txt +++ b/docs/doc-requirements.txt @@ -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 diff --git a/docs/environment.yml b/docs/environment.yml new file mode 100644 index 000000000..4e6ae8e95 --- /dev/null +++ b/docs/environment.yml @@ -0,0 +1,9 @@ +name: rtd +channels: + - defaults + - conda-forge +dependencies: + - python=3.10 + - pip + - pip: + - -r ../requirements.txt \ No newline at end of file diff --git a/examples_requirements.txt b/examples_requirements.txt index ed747cfb1..c42d81908 100644 --- a/examples_requirements.txt +++ b/examples_requirements.txt @@ -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 diff --git a/requirements.txt b/requirements.txt index 1ae79bd35..89cf23d0c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,2 @@ --r docs/requirements.txt +-r docs/doc-requirements.txt -r examples_requirements.txt