Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update doc dependencies #195

Merged
merged 10 commits into from
Mar 5, 2024
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/workflows/validate-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ jobs:

- uses: actions/setup-python@v3
with:
python-version: 3.8
python-version: "3.10"

- uses: actions/cache@v3.0.8
id: cache
Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ scores, intermediate_state_train, intermediate_state_agg = simulate_experiment(
### Changed

- BREAKING: rename ``datasamples``to ``data_from_opener`` ([#193](https://github.com/Substra/substrafl/pull/193))
- Bump documentation dependencies to Sphinx 7.2.6 ([#195](https://github.com/Substra/substrafl/pull/195))
- The predict task does not exist anymore. The evaluation of a model is done in a single task [#177](https://github.com/Substra/substrafl/pull/177)
- `Strategy` implement an `evaluate` method, with the `@remote_data` decorator, to compute the evaluation of the model. The `evaluate` method is the same for all strategies [#177](https://github.com/Substra/substrafl/pull/177)
- BREAKING: the `perform_predict` method of `Strategy` changed in favor of `perform_evaluation` that calls the new `evaluate` method [#177](https://github.com/Substra/substrafl/pull/177)
Expand Down
10 changes: 3 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,6 @@
# The master toctree document.
master_doc = "index"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
Expand Down Expand Up @@ -196,6 +189,9 @@
("py:class", "ComputePlan"),
("py:class", "Path"),
("py:class", "module"),
("py:class", "FieldInfo"),
("py:class", "ConfigDict"),
("py:class", "ComputedFieldInfo"),
]

html_css_files = [
Expand Down
17 changes: 7 additions & 10 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
sphinx==4.4.0
sphinx_rtd_theme==1.0.0
sphinx-autobuild==2020.9.1
texttable==1.6.3
myst-parser==0.16.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
docutils==0.16
sphinx_click==3.1.0
sphinx==7.2.6
sphinx-rtd-theme==2.0.0
sphinx-autobuild==2024.2.4
texttable==1.7.0
myst-parser==2.0.0
docutils==0.20.1
sphinx_click==5.1.0
Loading