From d619173f8c81d7e012bf66327e1a699142c2b67b Mon Sep 17 00:00:00 2001 From: RobertSamoilescu Date: Wed, 11 Dec 2024 11:27:10 +0000 Subject: [PATCH] Updated docs dependencies (#915) --- .github/workflows/ci.yml | 2 +- CONTRIBUTING.md | 2 +- requirements/docs.txt | 10 +++++----- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6589b9900..a1f1229ab 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -115,7 +115,7 @@ jobs: runs-on: ubuntu-latest container: - image: readthedocs/build:ubuntu-22.04-2022.03.15 + image: readthedocs/build:ubuntu-24.04-2024.06.17 options: --user root steps: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 293cefa4b..f8bd6d688 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,7 +27,7 @@ these hooks will be run to verify that the linting and type checking is correct. errors, the commit will fail and you will see the changes that need to be made. ## Testing -We use `pytest` to run tests. To run all tests just call `pytest alibi_detect` from the root of the project. +We use `pytest` to run tests. To run all tests just call `make test` from the root of the project. Test files live together with the library files under `tests` folders. ## Linter diff --git a/requirements/docs.txt b/requirements/docs.txt index 9795a07c7..84c91c874 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -1,13 +1,13 @@ # dependencies for building docs, separate from dev.txt as this is also used for builds on readthedocs.org # core dependencies -sphinx>=4.2.0, <8.0.0 -sphinx-autodoc-typehints>=1.12.0, <1.21 # limited due to https://github.com/tox-dev/sphinx-autodoc-typehints/issues/260 -sphinx-rtd-theme>=1.0.0, <2.0.0 -sphinxcontrib-apidoc>=0.3.0, <0.5.0 +sphinx>=4.2.0, <8.2.0 +sphinx-autodoc-typehints>=1.12.0, <2.6.0 +sphinx-rtd-theme>=1.0.0, <3.1.0 +sphinxcontrib-apidoc>=0.3.0, <0.6.0 sphinxcontrib-bibtex>=2.1.0, <3.0.0 myst-parser>=1.0, <3.0 nbsphinx>=0.8.5, <0.10.0 -sphinx_design==0.5.0 # Pinning for now as sphinx_design is v.new and still in flux. +sphinx_design==0.6.1 # Pinning for now as sphinx_design is v.new and still in flux. ipykernel>=5.1.0, <7.0.0 # required for executing notebooks via nbsphinx ipython>=7.2.0, <9.0.0 # required for executing notebooks nbsphinx # pandoc