From 069c186584b1648cc0b7df2d9cd225fdc13d9df1 Mon Sep 17 00:00:00 2001 From: Charles Beauville Date: Mon, 9 Dec 2024 05:10:10 -0800 Subject: [PATCH] docs(framework) Move framework docs to `framework/docs` (#4655) Co-authored-by: Daniel J. Beutel --- .github/workflows/docs.yml | 2 +- .github/workflows/update_translations.yml | 4 ++-- .gitignore | 6 +++--- dev/build-docs.sh | 2 +- dev/format.sh | 8 ++++---- dev/get-latest-changelog.sh | 2 +- dev/rm-caches.sh | 2 +- dev/test.sh | 4 ++-- {doc => framework/docs}/Makefile | 0 {doc => framework/docs}/build-versioned-docs.sh | 0 .../docs}/locales/fr/LC_MESSAGES/framework-docs.po | 0 .../docs}/locales/fr/LC_MESSAGES/sphinx.po | 0 .../docs}/locales/ko/LC_MESSAGES/framework-docs.po | 0 .../docs}/locales/ko/LC_MESSAGES/sphinx.po | 0 .../locales/pt_BR/LC_MESSAGES/framework-docs.po | 0 .../docs}/locales/pt_BR/LC_MESSAGES/sphinx.po | 0 .../locales/zh_Hans/LC_MESSAGES/framework-docs.po | 0 .../docs}/locales/zh_Hans/LC_MESSAGES/sphinx.po | 0 {doc => framework/docs}/make.bat | 0 {doc => framework/docs}/source/.gitignore | 0 {doc => framework/docs}/source/_static/DP/CDP.png | Bin {doc => framework/docs}/source/_static/DP/LDP.png | Bin .../docs}/source/_static/DP/clientsideCDP.png | Bin .../docs}/source/_static/DP/clipping.png | Bin .../docs}/source/_static/DP/dp-intro.png | Bin .../docs}/source/_static/DP/localdp.png | Bin .../docs}/source/_static/DP/serversideCDP.png | Bin .../docs}/source/_static/changes_requested.png | Bin .../docs}/source/_static/cloning_fork.png | Bin .../docs}/source/_static/cloning_repo.png | Bin .../docs}/source/_static/compare_and_pr.png | Bin .../docs}/source/_static/creating_pr.png | Bin {doc => framework/docs}/source/_static/custom.css | 0 {doc => framework/docs}/source/_static/draft_pr.png | Bin {doc => framework/docs}/source/_static/favicon.ico | Bin .../docs}/source/_static/flower-actors.drawio.png | Bin .../flower-architecture-basic-architecture.svg | 0 .../_static/flower-architecture-hub-and-spoke.svg | 0 .../_static/flower-architecture-multi-run-1.svg | 0 .../_static/flower-architecture-multi-run-2.svg | 0 .../_static/flower-architecture-multi-run.svg | 0 .../docs}/source/_static/flower-logo.png | Bin .../docs}/source/_static/fork_button.png | Bin .../docs}/source/_static/fork_link.png | Bin .../docs}/source/_static/forking-repo.png | Bin .../docs}/source/_static/github_schema.png | Bin .../docs}/source/_static/make_changes.png | Bin .../docs}/source/_static/merging_branch.png | Bin .../docs}/source/_static/merging_pr.png | Bin .../docs}/source/_static/opened_pr.png | Bin .../docs}/source/_static/opening-pr.png | Bin .../docs}/source/_static/resolve_conv.png | Bin .../_static/tutorial/central-model-training.png | Bin .../_static/tutorial/centralized-impossible.png | Bin .../_static/tutorial/centralized-possible.png | Bin .../docs}/source/_static/tutorial/collect-data.png | Bin .../docs}/source/_static/tutorial/data-on-phone.png | Bin .../_static/tutorial/fl-aggregate-model-updates.png | Bin .../_static/tutorial/fl-initialize-global-model.png | Bin .../source/_static/tutorial/fl-local-training.png | Bin .../_static/tutorial/fl-send-global-model.png | Bin .../_static/tutorial/fl-send-model-updates.png | Bin .../docs}/source/_static/tutorial/flower-any.jpeg | Bin .../_static/tutorial/many-devices-with-data.png | Bin .../source/_static/tutorial/model-and-data.png | Bin .../docs}/source/_static/tutorial/train-model.png | Bin .../docs}/source/_static/upstream_link.png | Bin .../docs}/source/_static/weblate_interface.png | Bin .../docs}/source/_static/weblate_status.png | Bin .../docs}/source/_templates/autosummary/base.rst | 0 .../docs}/source/_templates/autosummary/class.rst | 0 .../docs}/source/_templates/autosummary/module.rst | 0 {doc => framework/docs}/source/_templates/base.html | 0 .../docs}/source/_templates/sidebar/brand.html | 0 .../docs}/source/_templates/sidebar/lang.html | 0 .../docs}/source/_templates/sidebar/search.html | 0 .../docs}/source/_templates/sidebar/versioning.html | 0 {doc => framework/docs}/source/conf.py | 0 ...tributor-explanation-public-and-private-apis.rst | 0 .../contributor-how-to-build-docker-images.rst | 0 .../contributor-how-to-contribute-translations.rst | 0 ...utor-how-to-develop-in-vscode-dev-containers.rst | 0 ...tributor-how-to-install-development-versions.rst | 0 .../source/contributor-how-to-release-flower.rst | 0 .../contributor-how-to-set-up-a-virtual-env.rst | 0 .../contributor-how-to-write-documentation.rst | 0 .../contributor-ref-good-first-contributions.rst | 0 ...contributor-ref-secure-aggregation-protocols.rst | 0 .../contributor-tutorial-contribute-on-github.rst | 0 ...ibutor-tutorial-get-started-as-a-contributor.rst | 0 .../docs}/source/docker/enable-tls.rst | 0 {doc => framework/docs}/source/docker/index.rst | 0 .../docs}/source/docker/persist-superlink-state.rst | 0 .../docs}/source/docker/pin-version.rst | 0 .../docs}/source/docker/run-as-root-user.rst | 0 .../docs}/source/docker/run-as-subprocess.rst | 0 .../run-quickstart-examples-docker-compose.rst | 0 .../source/docker/set-environment-variables.rst | 0 .../docker/tutorial-deploy-on-multiple-machines.rst | 0 .../docker/tutorial-quickstart-docker-compose.rst | 0 .../source/docker/tutorial-quickstart-docker.rst | 0 .../docs}/source/docker/use-a-different-version.rst | 0 .../source/explanation-differential-privacy.rst | 0 .../source/explanation-federated-evaluation.rst | 0 .../source/explanation-flower-architecture.rst | 0 .../source/how-to-aggregate-evaluation-results.rst | 0 .../docs}/source/how-to-authenticate-supernodes.rst | 0 .../docs}/source/how-to-configure-clients.rst | 0 .../docs}/source/how-to-design-stateful-clients.rst | 0 .../docs}/source/how-to-enable-tls-connections.rst | 0 .../docs}/source/how-to-implement-fedbn.rst | 0 .../docs}/source/how-to-implement-strategies.rst | 0 .../docs}/source/how-to-install-flower.rst | 0 .../docs}/source/how-to-run-flower-on-azure.rst | 0 .../docs}/source/how-to-run-simulations.rst | 0 .../how-to-save-and-load-model-checkpoints.rst | 0 .../docs}/source/how-to-upgrade-to-flower-1.0.rst | 0 .../docs}/source/how-to-upgrade-to-flower-1.13.rst | 0 .../docs}/source/how-to-use-built-in-mods.rst | 0 .../source/how-to-use-differential-privacy.rst | 0 .../docs}/source/how-to-use-strategies.rst | 0 {doc => framework/docs}/source/index.rst | 0 {doc => framework/docs}/source/ref-api-cli.rst | 0 {doc => framework/docs}/source/ref-changelog.md | 0 .../docs}/source/ref-example-projects.rst | 0 {doc => framework/docs}/source/ref-faq.rst | 0 {doc => framework/docs}/source/ref-telemetry.md | 0 .../docs}/source/tutorial-quickstart-android.rst | 0 .../docs}/source/tutorial-quickstart-fastai.rst | 0 .../source/tutorial-quickstart-huggingface.rst | 0 .../docs}/source/tutorial-quickstart-ios.rst | 0 .../docs}/source/tutorial-quickstart-jax.rst | 0 .../docs}/source/tutorial-quickstart-mlx.rst | 0 .../docs}/source/tutorial-quickstart-pandas.rst | 0 .../tutorial-quickstart-pytorch-lightning.rst | 0 .../docs}/source/tutorial-quickstart-pytorch.rst | 0 .../source/tutorial-quickstart-scikitlearn.rst | 0 .../docs}/source/tutorial-quickstart-tensorflow.rst | 0 .../docs}/source/tutorial-quickstart-xgboost.rst | 0 ...ries-build-a-strategy-from-scratch-pytorch.ipynb | 0 ...torial-series-customize-the-client-pytorch.ipynb | 0 ...ial-series-get-started-with-flower-pytorch.ipynb | 0 ...-use-a-federated-learning-strategy-pytorch.ipynb | 0 ...tutorial-series-what-is-federated-learning.ipynb | 0 pyproject.toml | 8 ++++---- 145 files changed, 19 insertions(+), 19 deletions(-) rename {doc => framework/docs}/Makefile (100%) rename {doc => framework/docs}/build-versioned-docs.sh (100%) rename {doc => framework/docs}/locales/fr/LC_MESSAGES/framework-docs.po (100%) rename {doc => framework/docs}/locales/fr/LC_MESSAGES/sphinx.po (100%) rename {doc => framework/docs}/locales/ko/LC_MESSAGES/framework-docs.po (100%) rename {doc => framework/docs}/locales/ko/LC_MESSAGES/sphinx.po (100%) rename {doc => framework/docs}/locales/pt_BR/LC_MESSAGES/framework-docs.po (100%) rename {doc => framework/docs}/locales/pt_BR/LC_MESSAGES/sphinx.po (100%) rename {doc => framework/docs}/locales/zh_Hans/LC_MESSAGES/framework-docs.po (100%) rename {doc => framework/docs}/locales/zh_Hans/LC_MESSAGES/sphinx.po (100%) rename {doc => framework/docs}/make.bat (100%) rename {doc => framework/docs}/source/.gitignore (100%) rename {doc => framework/docs}/source/_static/DP/CDP.png (100%) rename {doc => framework/docs}/source/_static/DP/LDP.png (100%) rename {doc => framework/docs}/source/_static/DP/clientsideCDP.png (100%) rename {doc => framework/docs}/source/_static/DP/clipping.png (100%) rename {doc => framework/docs}/source/_static/DP/dp-intro.png (100%) rename {doc => framework/docs}/source/_static/DP/localdp.png (100%) rename {doc => framework/docs}/source/_static/DP/serversideCDP.png (100%) rename {doc => framework/docs}/source/_static/changes_requested.png (100%) rename {doc => framework/docs}/source/_static/cloning_fork.png (100%) rename {doc => framework/docs}/source/_static/cloning_repo.png (100%) rename {doc => framework/docs}/source/_static/compare_and_pr.png (100%) rename {doc => framework/docs}/source/_static/creating_pr.png (100%) rename {doc => framework/docs}/source/_static/custom.css (100%) rename {doc => framework/docs}/source/_static/draft_pr.png (100%) rename {doc => framework/docs}/source/_static/favicon.ico (100%) rename {doc => framework/docs}/source/_static/flower-actors.drawio.png (100%) rename {doc => framework/docs}/source/_static/flower-architecture-basic-architecture.svg (100%) rename {doc => framework/docs}/source/_static/flower-architecture-hub-and-spoke.svg (100%) rename {doc => framework/docs}/source/_static/flower-architecture-multi-run-1.svg (100%) rename {doc => framework/docs}/source/_static/flower-architecture-multi-run-2.svg (100%) rename {doc => framework/docs}/source/_static/flower-architecture-multi-run.svg (100%) rename {doc => framework/docs}/source/_static/flower-logo.png (100%) rename {doc => framework/docs}/source/_static/fork_button.png (100%) rename {doc => framework/docs}/source/_static/fork_link.png (100%) rename {doc => framework/docs}/source/_static/forking-repo.png (100%) rename {doc => framework/docs}/source/_static/github_schema.png (100%) rename {doc => framework/docs}/source/_static/make_changes.png (100%) rename {doc => framework/docs}/source/_static/merging_branch.png (100%) rename {doc => framework/docs}/source/_static/merging_pr.png (100%) rename {doc => framework/docs}/source/_static/opened_pr.png (100%) rename {doc => framework/docs}/source/_static/opening-pr.png (100%) rename {doc => framework/docs}/source/_static/resolve_conv.png (100%) rename {doc => framework/docs}/source/_static/tutorial/central-model-training.png (100%) rename {doc => framework/docs}/source/_static/tutorial/centralized-impossible.png (100%) rename {doc => framework/docs}/source/_static/tutorial/centralized-possible.png (100%) rename {doc => framework/docs}/source/_static/tutorial/collect-data.png (100%) rename {doc => framework/docs}/source/_static/tutorial/data-on-phone.png (100%) rename {doc => framework/docs}/source/_static/tutorial/fl-aggregate-model-updates.png (100%) rename {doc => framework/docs}/source/_static/tutorial/fl-initialize-global-model.png (100%) rename {doc => framework/docs}/source/_static/tutorial/fl-local-training.png (100%) rename {doc => framework/docs}/source/_static/tutorial/fl-send-global-model.png (100%) rename {doc => framework/docs}/source/_static/tutorial/fl-send-model-updates.png (100%) rename {doc => framework/docs}/source/_static/tutorial/flower-any.jpeg (100%) rename {doc => framework/docs}/source/_static/tutorial/many-devices-with-data.png (100%) rename {doc => framework/docs}/source/_static/tutorial/model-and-data.png (100%) rename {doc => framework/docs}/source/_static/tutorial/train-model.png (100%) rename {doc => framework/docs}/source/_static/upstream_link.png (100%) rename {doc => framework/docs}/source/_static/weblate_interface.png (100%) rename {doc => framework/docs}/source/_static/weblate_status.png (100%) rename {doc => framework/docs}/source/_templates/autosummary/base.rst (100%) rename {doc => framework/docs}/source/_templates/autosummary/class.rst (100%) rename {doc => framework/docs}/source/_templates/autosummary/module.rst (100%) rename {doc => framework/docs}/source/_templates/base.html (100%) rename {doc => framework/docs}/source/_templates/sidebar/brand.html (100%) rename {doc => framework/docs}/source/_templates/sidebar/lang.html (100%) rename {doc => framework/docs}/source/_templates/sidebar/search.html (100%) rename {doc => framework/docs}/source/_templates/sidebar/versioning.html (100%) rename {doc => framework/docs}/source/conf.py (100%) rename {doc => framework/docs}/source/contributor-explanation-public-and-private-apis.rst (100%) rename {doc => framework/docs}/source/contributor-how-to-build-docker-images.rst (100%) rename {doc => framework/docs}/source/contributor-how-to-contribute-translations.rst (100%) rename {doc => framework/docs}/source/contributor-how-to-develop-in-vscode-dev-containers.rst (100%) rename {doc => framework/docs}/source/contributor-how-to-install-development-versions.rst (100%) rename {doc => framework/docs}/source/contributor-how-to-release-flower.rst (100%) rename {doc => framework/docs}/source/contributor-how-to-set-up-a-virtual-env.rst (100%) rename {doc => framework/docs}/source/contributor-how-to-write-documentation.rst (100%) rename {doc => framework/docs}/source/contributor-ref-good-first-contributions.rst (100%) rename {doc => framework/docs}/source/contributor-ref-secure-aggregation-protocols.rst (100%) rename {doc => framework/docs}/source/contributor-tutorial-contribute-on-github.rst (100%) rename {doc => framework/docs}/source/contributor-tutorial-get-started-as-a-contributor.rst (100%) rename {doc => framework/docs}/source/docker/enable-tls.rst (100%) rename {doc => framework/docs}/source/docker/index.rst (100%) rename {doc => framework/docs}/source/docker/persist-superlink-state.rst (100%) rename {doc => framework/docs}/source/docker/pin-version.rst (100%) rename {doc => framework/docs}/source/docker/run-as-root-user.rst (100%) rename {doc => framework/docs}/source/docker/run-as-subprocess.rst (100%) rename {doc => framework/docs}/source/docker/run-quickstart-examples-docker-compose.rst (100%) rename {doc => framework/docs}/source/docker/set-environment-variables.rst (100%) rename {doc => framework/docs}/source/docker/tutorial-deploy-on-multiple-machines.rst (100%) rename {doc => framework/docs}/source/docker/tutorial-quickstart-docker-compose.rst (100%) rename {doc => framework/docs}/source/docker/tutorial-quickstart-docker.rst (100%) rename {doc => framework/docs}/source/docker/use-a-different-version.rst (100%) rename {doc => framework/docs}/source/explanation-differential-privacy.rst (100%) rename {doc => framework/docs}/source/explanation-federated-evaluation.rst (100%) rename {doc => framework/docs}/source/explanation-flower-architecture.rst (100%) rename {doc => framework/docs}/source/how-to-aggregate-evaluation-results.rst (100%) rename {doc => framework/docs}/source/how-to-authenticate-supernodes.rst (100%) rename {doc => framework/docs}/source/how-to-configure-clients.rst (100%) rename {doc => framework/docs}/source/how-to-design-stateful-clients.rst (100%) rename {doc => framework/docs}/source/how-to-enable-tls-connections.rst (100%) rename {doc => framework/docs}/source/how-to-implement-fedbn.rst (100%) rename {doc => framework/docs}/source/how-to-implement-strategies.rst (100%) rename {doc => framework/docs}/source/how-to-install-flower.rst (100%) rename {doc => framework/docs}/source/how-to-run-flower-on-azure.rst (100%) rename {doc => framework/docs}/source/how-to-run-simulations.rst (100%) rename {doc => framework/docs}/source/how-to-save-and-load-model-checkpoints.rst (100%) rename {doc => framework/docs}/source/how-to-upgrade-to-flower-1.0.rst (100%) rename {doc => framework/docs}/source/how-to-upgrade-to-flower-1.13.rst (100%) rename {doc => framework/docs}/source/how-to-use-built-in-mods.rst (100%) rename {doc => framework/docs}/source/how-to-use-differential-privacy.rst (100%) rename {doc => framework/docs}/source/how-to-use-strategies.rst (100%) rename {doc => framework/docs}/source/index.rst (100%) rename {doc => framework/docs}/source/ref-api-cli.rst (100%) rename {doc => framework/docs}/source/ref-changelog.md (100%) rename {doc => framework/docs}/source/ref-example-projects.rst (100%) rename {doc => framework/docs}/source/ref-faq.rst (100%) rename {doc => framework/docs}/source/ref-telemetry.md (100%) rename {doc => framework/docs}/source/tutorial-quickstart-android.rst (100%) rename {doc => framework/docs}/source/tutorial-quickstart-fastai.rst (100%) rename {doc => framework/docs}/source/tutorial-quickstart-huggingface.rst (100%) rename {doc => framework/docs}/source/tutorial-quickstart-ios.rst (100%) rename {doc => framework/docs}/source/tutorial-quickstart-jax.rst (100%) rename {doc => framework/docs}/source/tutorial-quickstart-mlx.rst (100%) rename {doc => framework/docs}/source/tutorial-quickstart-pandas.rst (100%) rename {doc => framework/docs}/source/tutorial-quickstart-pytorch-lightning.rst (100%) rename {doc => framework/docs}/source/tutorial-quickstart-pytorch.rst (100%) rename {doc => framework/docs}/source/tutorial-quickstart-scikitlearn.rst (100%) rename {doc => framework/docs}/source/tutorial-quickstart-tensorflow.rst (100%) rename {doc => framework/docs}/source/tutorial-quickstart-xgboost.rst (100%) rename {doc => framework/docs}/source/tutorial-series-build-a-strategy-from-scratch-pytorch.ipynb (100%) rename {doc => framework/docs}/source/tutorial-series-customize-the-client-pytorch.ipynb (100%) rename {doc => framework/docs}/source/tutorial-series-get-started-with-flower-pytorch.ipynb (100%) rename {doc => framework/docs}/source/tutorial-series-use-a-federated-learning-strategy-pytorch.ipynb (100%) rename {doc => framework/docs}/source/tutorial-series-what-is-federated-learning.ipynb (100%) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3f010a4c37b0..a4b3455d8c6c 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -45,7 +45,7 @@ jobs: AWS_SECRET_ACCESS_KEY: ${{ secrets. AWS_SECRET_ACCESS_KEY }} DOCS_BUCKET: flower.ai run: | - aws s3 sync --delete --exclude ".*" --exclude "v/*" --cache-control "no-cache" ./doc/build/html/ s3://${{ env.DOCS_BUCKET }}/docs/framework + aws s3 sync --delete --exclude ".*" --exclude "v/*" --cache-control "no-cache" ./framework/docs/build/html/ s3://${{ env.DOCS_BUCKET }}/docs/framework aws s3 sync --delete --exclude ".*" --exclude "v/*" --cache-control "no-cache" ./baselines/doc/build/html/ s3://${{ env.DOCS_BUCKET }}/docs/baselines aws s3 sync --delete --exclude ".*" --exclude "v/*" --cache-control "no-cache" ./examples/doc/build/html/ s3://${{ env.DOCS_BUCKET }}/docs/examples aws s3 sync --delete --exclude ".*" --exclude "v/*" --cache-control "no-cache" ./datasets/doc/build/html/ s3://${{ env.DOCS_BUCKET }}/docs/datasets diff --git a/.github/workflows/update_translations.yml b/.github/workflows/update_translations.yml index 9a5391a40438..ec748befb33c 100644 --- a/.github/workflows/update_translations.yml +++ b/.github/workflows/update_translations.yml @@ -38,7 +38,7 @@ jobs: - name: Update text and translations for all locales run: | - cd doc + cd framework/docs make update-text for langDir in locales/*; do if [ -d "$langDir" ]; then @@ -52,7 +52,7 @@ jobs: run: | git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com" git config --local user.name "github-actions[bot]" - git add doc/locales + git add framework/docs/locales git commit -m "Update text and language files" continue-on-error: true diff --git a/.gitignore b/.gitignore index 96789cbf6e00..9af2d29f2315 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,9 @@ # Flower .flower_ops data/ -doc/source/api_documentation -doc/source/_build -doc/source/dataset/ +framework/docs/source/api_documentation +framework/docs/source/_build +framework/docs/source/dataset/ flwr_logs .cache diff --git a/dev/build-docs.sh b/dev/build-docs.sh index f4bf958b0ebf..bdfd33ad626d 100755 --- a/dev/build-docs.sh +++ b/dev/build-docs.sh @@ -14,7 +14,7 @@ cd $ROOT ./datasets/dev/build-flwr-datasets-docs.sh cd $ROOT -cd doc +cd framework/docs if [ "$1" = true ]; then ./build-versioned-docs.sh diff --git a/dev/format.sh b/dev/format.sh index a3129b932e5d..8ad739be529a 100755 --- a/dev/format.sh +++ b/dev/format.sh @@ -31,13 +31,13 @@ python -m black -q e2e python -m docformatter -i -r e2e # Notebooks -python -m black --ipynb -q doc/source/*.ipynb +python -m black --ipynb -q framework/docs/source/*.ipynb KEYS="metadata.celltoolbar metadata.language_info metadata.toc metadata.notify_time metadata.varInspector metadata.accelerator metadata.vscode cell.metadata.id cell.metadata.heading_collapsed cell.metadata.hidden cell.metadata.code_folding cell.metadata.tags cell.metadata.init_cell cell.metadata.vscode cell.metadata.pycharm" -python -m nbstripout doc/source/*.ipynb --extra-keys "$KEYS" +python -m nbstripout framework/docs/source/*.ipynb --extra-keys "$KEYS" python -m nbstripout examples/*/*.ipynb --extra-keys "$KEYS" # Markdown -python -m mdformat --number doc/source examples +python -m mdformat --number framework/docs/source examples # RST -docstrfmt doc/source +docstrfmt framework/docs/source diff --git a/dev/get-latest-changelog.sh b/dev/get-latest-changelog.sh index 1d4a6b6bf58f..9cf8a5069253 100755 --- a/dev/get-latest-changelog.sh +++ b/dev/get-latest-changelog.sh @@ -9,7 +9,7 @@ tags=$(git tag --sort=-v:refname) new_version=$(echo "$tags" | sed -n '1p') old_version=$(echo "$tags" | sed -n '2p') -awk '{sub(//, ""); print}' doc/source/ref-changelog.md | awk -v start="$new_version" -v end="$old_version" ' +awk '{sub(//, ""); print}' framework/docs/source/ref-changelog.md | awk -v start="$new_version" -v end="$old_version" ' $0 ~ start {flag=1; next} $0 ~ end {flag=0} flag && !printed && /^$/ {next} # skip the first blank line diff --git a/dev/rm-caches.sh b/dev/rm-caches.sh index d5b004fb834c..eddd9c9e947a 100755 --- a/dev/rm-caches.sh +++ b/dev/rm-caches.sh @@ -6,4 +6,4 @@ find src -type d -name __pycache__ -exec rm -r {} \+ rm -rf .mypy_cache rm -rf .pytest_cache rm -rf .cache -rm -rf doc/build +rm -rf framework/docs/build diff --git a/dev/test.sh b/dev/test.sh index b8eeed14bc46..c6a45602b34c 100755 --- a/dev/test.sh +++ b/dev/test.sh @@ -55,7 +55,7 @@ echo "- All Python checks passed" echo "- Start Markdown checks" echo "- mdformat: start" -python -m mdformat --check --number doc/source examples +python -m mdformat --check --number framework/docs/source examples echo "- mdformat: done" echo "- All Markdown checks passed" @@ -71,7 +71,7 @@ echo "- All TOML checks passed" echo "- Start rST checks" echo "- docstrfmt: start" -docstrfmt --check doc/source +docstrfmt --check framework/docs/source echo "- docstrfmt: done" echo "- All rST checks passed" diff --git a/doc/Makefile b/framework/docs/Makefile similarity index 100% rename from doc/Makefile rename to framework/docs/Makefile diff --git a/doc/build-versioned-docs.sh b/framework/docs/build-versioned-docs.sh similarity index 100% rename from doc/build-versioned-docs.sh rename to framework/docs/build-versioned-docs.sh diff --git a/doc/locales/fr/LC_MESSAGES/framework-docs.po b/framework/docs/locales/fr/LC_MESSAGES/framework-docs.po similarity index 100% rename from doc/locales/fr/LC_MESSAGES/framework-docs.po rename to framework/docs/locales/fr/LC_MESSAGES/framework-docs.po diff --git a/doc/locales/fr/LC_MESSAGES/sphinx.po b/framework/docs/locales/fr/LC_MESSAGES/sphinx.po similarity index 100% rename from doc/locales/fr/LC_MESSAGES/sphinx.po rename to framework/docs/locales/fr/LC_MESSAGES/sphinx.po diff --git a/doc/locales/ko/LC_MESSAGES/framework-docs.po b/framework/docs/locales/ko/LC_MESSAGES/framework-docs.po similarity index 100% rename from doc/locales/ko/LC_MESSAGES/framework-docs.po rename to framework/docs/locales/ko/LC_MESSAGES/framework-docs.po diff --git a/doc/locales/ko/LC_MESSAGES/sphinx.po b/framework/docs/locales/ko/LC_MESSAGES/sphinx.po similarity index 100% rename from doc/locales/ko/LC_MESSAGES/sphinx.po rename to framework/docs/locales/ko/LC_MESSAGES/sphinx.po diff --git a/doc/locales/pt_BR/LC_MESSAGES/framework-docs.po b/framework/docs/locales/pt_BR/LC_MESSAGES/framework-docs.po similarity index 100% rename from doc/locales/pt_BR/LC_MESSAGES/framework-docs.po rename to framework/docs/locales/pt_BR/LC_MESSAGES/framework-docs.po diff --git a/doc/locales/pt_BR/LC_MESSAGES/sphinx.po b/framework/docs/locales/pt_BR/LC_MESSAGES/sphinx.po similarity index 100% rename from doc/locales/pt_BR/LC_MESSAGES/sphinx.po rename to framework/docs/locales/pt_BR/LC_MESSAGES/sphinx.po diff --git a/doc/locales/zh_Hans/LC_MESSAGES/framework-docs.po b/framework/docs/locales/zh_Hans/LC_MESSAGES/framework-docs.po similarity index 100% rename from doc/locales/zh_Hans/LC_MESSAGES/framework-docs.po rename to framework/docs/locales/zh_Hans/LC_MESSAGES/framework-docs.po diff --git a/doc/locales/zh_Hans/LC_MESSAGES/sphinx.po b/framework/docs/locales/zh_Hans/LC_MESSAGES/sphinx.po similarity index 100% rename from doc/locales/zh_Hans/LC_MESSAGES/sphinx.po rename to framework/docs/locales/zh_Hans/LC_MESSAGES/sphinx.po diff --git a/doc/make.bat b/framework/docs/make.bat similarity index 100% rename from doc/make.bat rename to framework/docs/make.bat diff --git a/doc/source/.gitignore b/framework/docs/source/.gitignore similarity index 100% rename from doc/source/.gitignore rename to framework/docs/source/.gitignore diff --git a/doc/source/_static/DP/CDP.png b/framework/docs/source/_static/DP/CDP.png similarity index 100% rename from doc/source/_static/DP/CDP.png rename to framework/docs/source/_static/DP/CDP.png diff --git a/doc/source/_static/DP/LDP.png b/framework/docs/source/_static/DP/LDP.png similarity index 100% rename from doc/source/_static/DP/LDP.png rename to framework/docs/source/_static/DP/LDP.png diff --git a/doc/source/_static/DP/clientsideCDP.png b/framework/docs/source/_static/DP/clientsideCDP.png similarity index 100% rename from doc/source/_static/DP/clientsideCDP.png rename to framework/docs/source/_static/DP/clientsideCDP.png diff --git a/doc/source/_static/DP/clipping.png b/framework/docs/source/_static/DP/clipping.png similarity index 100% rename from doc/source/_static/DP/clipping.png rename to framework/docs/source/_static/DP/clipping.png diff --git a/doc/source/_static/DP/dp-intro.png b/framework/docs/source/_static/DP/dp-intro.png similarity index 100% rename from doc/source/_static/DP/dp-intro.png rename to framework/docs/source/_static/DP/dp-intro.png diff --git a/doc/source/_static/DP/localdp.png b/framework/docs/source/_static/DP/localdp.png similarity index 100% rename from doc/source/_static/DP/localdp.png rename to framework/docs/source/_static/DP/localdp.png diff --git a/doc/source/_static/DP/serversideCDP.png b/framework/docs/source/_static/DP/serversideCDP.png similarity index 100% rename from doc/source/_static/DP/serversideCDP.png rename to framework/docs/source/_static/DP/serversideCDP.png diff --git a/doc/source/_static/changes_requested.png b/framework/docs/source/_static/changes_requested.png similarity index 100% rename from doc/source/_static/changes_requested.png rename to framework/docs/source/_static/changes_requested.png diff --git a/doc/source/_static/cloning_fork.png b/framework/docs/source/_static/cloning_fork.png similarity index 100% rename from doc/source/_static/cloning_fork.png rename to framework/docs/source/_static/cloning_fork.png diff --git a/doc/source/_static/cloning_repo.png b/framework/docs/source/_static/cloning_repo.png similarity index 100% rename from doc/source/_static/cloning_repo.png rename to framework/docs/source/_static/cloning_repo.png diff --git a/doc/source/_static/compare_and_pr.png b/framework/docs/source/_static/compare_and_pr.png similarity index 100% rename from doc/source/_static/compare_and_pr.png rename to framework/docs/source/_static/compare_and_pr.png diff --git a/doc/source/_static/creating_pr.png b/framework/docs/source/_static/creating_pr.png similarity index 100% rename from doc/source/_static/creating_pr.png rename to framework/docs/source/_static/creating_pr.png diff --git a/doc/source/_static/custom.css b/framework/docs/source/_static/custom.css similarity index 100% rename from doc/source/_static/custom.css rename to framework/docs/source/_static/custom.css diff --git a/doc/source/_static/draft_pr.png b/framework/docs/source/_static/draft_pr.png similarity index 100% rename from doc/source/_static/draft_pr.png rename to framework/docs/source/_static/draft_pr.png diff --git a/doc/source/_static/favicon.ico b/framework/docs/source/_static/favicon.ico similarity index 100% rename from doc/source/_static/favicon.ico rename to framework/docs/source/_static/favicon.ico diff --git a/doc/source/_static/flower-actors.drawio.png b/framework/docs/source/_static/flower-actors.drawio.png similarity index 100% rename from doc/source/_static/flower-actors.drawio.png rename to framework/docs/source/_static/flower-actors.drawio.png diff --git a/doc/source/_static/flower-architecture-basic-architecture.svg b/framework/docs/source/_static/flower-architecture-basic-architecture.svg similarity index 100% rename from doc/source/_static/flower-architecture-basic-architecture.svg rename to framework/docs/source/_static/flower-architecture-basic-architecture.svg diff --git a/doc/source/_static/flower-architecture-hub-and-spoke.svg b/framework/docs/source/_static/flower-architecture-hub-and-spoke.svg similarity index 100% rename from doc/source/_static/flower-architecture-hub-and-spoke.svg rename to framework/docs/source/_static/flower-architecture-hub-and-spoke.svg diff --git a/doc/source/_static/flower-architecture-multi-run-1.svg b/framework/docs/source/_static/flower-architecture-multi-run-1.svg similarity index 100% rename from doc/source/_static/flower-architecture-multi-run-1.svg rename to framework/docs/source/_static/flower-architecture-multi-run-1.svg diff --git a/doc/source/_static/flower-architecture-multi-run-2.svg b/framework/docs/source/_static/flower-architecture-multi-run-2.svg similarity index 100% rename from doc/source/_static/flower-architecture-multi-run-2.svg rename to framework/docs/source/_static/flower-architecture-multi-run-2.svg diff --git a/doc/source/_static/flower-architecture-multi-run.svg b/framework/docs/source/_static/flower-architecture-multi-run.svg similarity index 100% rename from doc/source/_static/flower-architecture-multi-run.svg rename to framework/docs/source/_static/flower-architecture-multi-run.svg diff --git a/doc/source/_static/flower-logo.png b/framework/docs/source/_static/flower-logo.png similarity index 100% rename from doc/source/_static/flower-logo.png rename to framework/docs/source/_static/flower-logo.png diff --git a/doc/source/_static/fork_button.png b/framework/docs/source/_static/fork_button.png similarity index 100% rename from doc/source/_static/fork_button.png rename to framework/docs/source/_static/fork_button.png diff --git a/doc/source/_static/fork_link.png b/framework/docs/source/_static/fork_link.png similarity index 100% rename from doc/source/_static/fork_link.png rename to framework/docs/source/_static/fork_link.png diff --git a/doc/source/_static/forking-repo.png b/framework/docs/source/_static/forking-repo.png similarity index 100% rename from doc/source/_static/forking-repo.png rename to framework/docs/source/_static/forking-repo.png diff --git a/doc/source/_static/github_schema.png b/framework/docs/source/_static/github_schema.png similarity index 100% rename from doc/source/_static/github_schema.png rename to framework/docs/source/_static/github_schema.png diff --git a/doc/source/_static/make_changes.png b/framework/docs/source/_static/make_changes.png similarity index 100% rename from doc/source/_static/make_changes.png rename to framework/docs/source/_static/make_changes.png diff --git a/doc/source/_static/merging_branch.png b/framework/docs/source/_static/merging_branch.png similarity index 100% rename from doc/source/_static/merging_branch.png rename to framework/docs/source/_static/merging_branch.png diff --git a/doc/source/_static/merging_pr.png b/framework/docs/source/_static/merging_pr.png similarity index 100% rename from doc/source/_static/merging_pr.png rename to framework/docs/source/_static/merging_pr.png diff --git a/doc/source/_static/opened_pr.png b/framework/docs/source/_static/opened_pr.png similarity index 100% rename from doc/source/_static/opened_pr.png rename to framework/docs/source/_static/opened_pr.png diff --git a/doc/source/_static/opening-pr.png b/framework/docs/source/_static/opening-pr.png similarity index 100% rename from doc/source/_static/opening-pr.png rename to framework/docs/source/_static/opening-pr.png diff --git a/doc/source/_static/resolve_conv.png b/framework/docs/source/_static/resolve_conv.png similarity index 100% rename from doc/source/_static/resolve_conv.png rename to framework/docs/source/_static/resolve_conv.png diff --git a/doc/source/_static/tutorial/central-model-training.png b/framework/docs/source/_static/tutorial/central-model-training.png similarity index 100% rename from doc/source/_static/tutorial/central-model-training.png rename to framework/docs/source/_static/tutorial/central-model-training.png diff --git a/doc/source/_static/tutorial/centralized-impossible.png b/framework/docs/source/_static/tutorial/centralized-impossible.png similarity index 100% rename from doc/source/_static/tutorial/centralized-impossible.png rename to framework/docs/source/_static/tutorial/centralized-impossible.png diff --git a/doc/source/_static/tutorial/centralized-possible.png b/framework/docs/source/_static/tutorial/centralized-possible.png similarity index 100% rename from doc/source/_static/tutorial/centralized-possible.png rename to framework/docs/source/_static/tutorial/centralized-possible.png diff --git a/doc/source/_static/tutorial/collect-data.png b/framework/docs/source/_static/tutorial/collect-data.png similarity index 100% rename from doc/source/_static/tutorial/collect-data.png rename to framework/docs/source/_static/tutorial/collect-data.png diff --git a/doc/source/_static/tutorial/data-on-phone.png b/framework/docs/source/_static/tutorial/data-on-phone.png similarity index 100% rename from doc/source/_static/tutorial/data-on-phone.png rename to framework/docs/source/_static/tutorial/data-on-phone.png diff --git a/doc/source/_static/tutorial/fl-aggregate-model-updates.png b/framework/docs/source/_static/tutorial/fl-aggregate-model-updates.png similarity index 100% rename from doc/source/_static/tutorial/fl-aggregate-model-updates.png rename to framework/docs/source/_static/tutorial/fl-aggregate-model-updates.png diff --git a/doc/source/_static/tutorial/fl-initialize-global-model.png b/framework/docs/source/_static/tutorial/fl-initialize-global-model.png similarity index 100% rename from doc/source/_static/tutorial/fl-initialize-global-model.png rename to framework/docs/source/_static/tutorial/fl-initialize-global-model.png diff --git a/doc/source/_static/tutorial/fl-local-training.png b/framework/docs/source/_static/tutorial/fl-local-training.png similarity index 100% rename from doc/source/_static/tutorial/fl-local-training.png rename to framework/docs/source/_static/tutorial/fl-local-training.png diff --git a/doc/source/_static/tutorial/fl-send-global-model.png b/framework/docs/source/_static/tutorial/fl-send-global-model.png similarity index 100% rename from doc/source/_static/tutorial/fl-send-global-model.png rename to framework/docs/source/_static/tutorial/fl-send-global-model.png diff --git a/doc/source/_static/tutorial/fl-send-model-updates.png b/framework/docs/source/_static/tutorial/fl-send-model-updates.png similarity index 100% rename from doc/source/_static/tutorial/fl-send-model-updates.png rename to framework/docs/source/_static/tutorial/fl-send-model-updates.png diff --git a/doc/source/_static/tutorial/flower-any.jpeg b/framework/docs/source/_static/tutorial/flower-any.jpeg similarity index 100% rename from doc/source/_static/tutorial/flower-any.jpeg rename to framework/docs/source/_static/tutorial/flower-any.jpeg diff --git a/doc/source/_static/tutorial/many-devices-with-data.png b/framework/docs/source/_static/tutorial/many-devices-with-data.png similarity index 100% rename from doc/source/_static/tutorial/many-devices-with-data.png rename to framework/docs/source/_static/tutorial/many-devices-with-data.png diff --git a/doc/source/_static/tutorial/model-and-data.png b/framework/docs/source/_static/tutorial/model-and-data.png similarity index 100% rename from doc/source/_static/tutorial/model-and-data.png rename to framework/docs/source/_static/tutorial/model-and-data.png diff --git a/doc/source/_static/tutorial/train-model.png b/framework/docs/source/_static/tutorial/train-model.png similarity index 100% rename from doc/source/_static/tutorial/train-model.png rename to framework/docs/source/_static/tutorial/train-model.png diff --git a/doc/source/_static/upstream_link.png b/framework/docs/source/_static/upstream_link.png similarity index 100% rename from doc/source/_static/upstream_link.png rename to framework/docs/source/_static/upstream_link.png diff --git a/doc/source/_static/weblate_interface.png b/framework/docs/source/_static/weblate_interface.png similarity index 100% rename from doc/source/_static/weblate_interface.png rename to framework/docs/source/_static/weblate_interface.png diff --git a/doc/source/_static/weblate_status.png b/framework/docs/source/_static/weblate_status.png similarity index 100% rename from doc/source/_static/weblate_status.png rename to framework/docs/source/_static/weblate_status.png diff --git a/doc/source/_templates/autosummary/base.rst b/framework/docs/source/_templates/autosummary/base.rst similarity index 100% rename from doc/source/_templates/autosummary/base.rst rename to framework/docs/source/_templates/autosummary/base.rst diff --git a/doc/source/_templates/autosummary/class.rst b/framework/docs/source/_templates/autosummary/class.rst similarity index 100% rename from doc/source/_templates/autosummary/class.rst rename to framework/docs/source/_templates/autosummary/class.rst diff --git a/doc/source/_templates/autosummary/module.rst b/framework/docs/source/_templates/autosummary/module.rst similarity index 100% rename from doc/source/_templates/autosummary/module.rst rename to framework/docs/source/_templates/autosummary/module.rst diff --git a/doc/source/_templates/base.html b/framework/docs/source/_templates/base.html similarity index 100% rename from doc/source/_templates/base.html rename to framework/docs/source/_templates/base.html diff --git a/doc/source/_templates/sidebar/brand.html b/framework/docs/source/_templates/sidebar/brand.html similarity index 100% rename from doc/source/_templates/sidebar/brand.html rename to framework/docs/source/_templates/sidebar/brand.html diff --git a/doc/source/_templates/sidebar/lang.html b/framework/docs/source/_templates/sidebar/lang.html similarity index 100% rename from doc/source/_templates/sidebar/lang.html rename to framework/docs/source/_templates/sidebar/lang.html diff --git a/doc/source/_templates/sidebar/search.html b/framework/docs/source/_templates/sidebar/search.html similarity index 100% rename from doc/source/_templates/sidebar/search.html rename to framework/docs/source/_templates/sidebar/search.html diff --git a/doc/source/_templates/sidebar/versioning.html b/framework/docs/source/_templates/sidebar/versioning.html similarity index 100% rename from doc/source/_templates/sidebar/versioning.html rename to framework/docs/source/_templates/sidebar/versioning.html diff --git a/doc/source/conf.py b/framework/docs/source/conf.py similarity index 100% rename from doc/source/conf.py rename to framework/docs/source/conf.py diff --git a/doc/source/contributor-explanation-public-and-private-apis.rst b/framework/docs/source/contributor-explanation-public-and-private-apis.rst similarity index 100% rename from doc/source/contributor-explanation-public-and-private-apis.rst rename to framework/docs/source/contributor-explanation-public-and-private-apis.rst diff --git a/doc/source/contributor-how-to-build-docker-images.rst b/framework/docs/source/contributor-how-to-build-docker-images.rst similarity index 100% rename from doc/source/contributor-how-to-build-docker-images.rst rename to framework/docs/source/contributor-how-to-build-docker-images.rst diff --git a/doc/source/contributor-how-to-contribute-translations.rst b/framework/docs/source/contributor-how-to-contribute-translations.rst similarity index 100% rename from doc/source/contributor-how-to-contribute-translations.rst rename to framework/docs/source/contributor-how-to-contribute-translations.rst diff --git a/doc/source/contributor-how-to-develop-in-vscode-dev-containers.rst b/framework/docs/source/contributor-how-to-develop-in-vscode-dev-containers.rst similarity index 100% rename from doc/source/contributor-how-to-develop-in-vscode-dev-containers.rst rename to framework/docs/source/contributor-how-to-develop-in-vscode-dev-containers.rst diff --git a/doc/source/contributor-how-to-install-development-versions.rst b/framework/docs/source/contributor-how-to-install-development-versions.rst similarity index 100% rename from doc/source/contributor-how-to-install-development-versions.rst rename to framework/docs/source/contributor-how-to-install-development-versions.rst diff --git a/doc/source/contributor-how-to-release-flower.rst b/framework/docs/source/contributor-how-to-release-flower.rst similarity index 100% rename from doc/source/contributor-how-to-release-flower.rst rename to framework/docs/source/contributor-how-to-release-flower.rst diff --git a/doc/source/contributor-how-to-set-up-a-virtual-env.rst b/framework/docs/source/contributor-how-to-set-up-a-virtual-env.rst similarity index 100% rename from doc/source/contributor-how-to-set-up-a-virtual-env.rst rename to framework/docs/source/contributor-how-to-set-up-a-virtual-env.rst diff --git a/doc/source/contributor-how-to-write-documentation.rst b/framework/docs/source/contributor-how-to-write-documentation.rst similarity index 100% rename from doc/source/contributor-how-to-write-documentation.rst rename to framework/docs/source/contributor-how-to-write-documentation.rst diff --git a/doc/source/contributor-ref-good-first-contributions.rst b/framework/docs/source/contributor-ref-good-first-contributions.rst similarity index 100% rename from doc/source/contributor-ref-good-first-contributions.rst rename to framework/docs/source/contributor-ref-good-first-contributions.rst diff --git a/doc/source/contributor-ref-secure-aggregation-protocols.rst b/framework/docs/source/contributor-ref-secure-aggregation-protocols.rst similarity index 100% rename from doc/source/contributor-ref-secure-aggregation-protocols.rst rename to framework/docs/source/contributor-ref-secure-aggregation-protocols.rst diff --git a/doc/source/contributor-tutorial-contribute-on-github.rst b/framework/docs/source/contributor-tutorial-contribute-on-github.rst similarity index 100% rename from doc/source/contributor-tutorial-contribute-on-github.rst rename to framework/docs/source/contributor-tutorial-contribute-on-github.rst diff --git a/doc/source/contributor-tutorial-get-started-as-a-contributor.rst b/framework/docs/source/contributor-tutorial-get-started-as-a-contributor.rst similarity index 100% rename from doc/source/contributor-tutorial-get-started-as-a-contributor.rst rename to framework/docs/source/contributor-tutorial-get-started-as-a-contributor.rst diff --git a/doc/source/docker/enable-tls.rst b/framework/docs/source/docker/enable-tls.rst similarity index 100% rename from doc/source/docker/enable-tls.rst rename to framework/docs/source/docker/enable-tls.rst diff --git a/doc/source/docker/index.rst b/framework/docs/source/docker/index.rst similarity index 100% rename from doc/source/docker/index.rst rename to framework/docs/source/docker/index.rst diff --git a/doc/source/docker/persist-superlink-state.rst b/framework/docs/source/docker/persist-superlink-state.rst similarity index 100% rename from doc/source/docker/persist-superlink-state.rst rename to framework/docs/source/docker/persist-superlink-state.rst diff --git a/doc/source/docker/pin-version.rst b/framework/docs/source/docker/pin-version.rst similarity index 100% rename from doc/source/docker/pin-version.rst rename to framework/docs/source/docker/pin-version.rst diff --git a/doc/source/docker/run-as-root-user.rst b/framework/docs/source/docker/run-as-root-user.rst similarity index 100% rename from doc/source/docker/run-as-root-user.rst rename to framework/docs/source/docker/run-as-root-user.rst diff --git a/doc/source/docker/run-as-subprocess.rst b/framework/docs/source/docker/run-as-subprocess.rst similarity index 100% rename from doc/source/docker/run-as-subprocess.rst rename to framework/docs/source/docker/run-as-subprocess.rst diff --git a/doc/source/docker/run-quickstart-examples-docker-compose.rst b/framework/docs/source/docker/run-quickstart-examples-docker-compose.rst similarity index 100% rename from doc/source/docker/run-quickstart-examples-docker-compose.rst rename to framework/docs/source/docker/run-quickstart-examples-docker-compose.rst diff --git a/doc/source/docker/set-environment-variables.rst b/framework/docs/source/docker/set-environment-variables.rst similarity index 100% rename from doc/source/docker/set-environment-variables.rst rename to framework/docs/source/docker/set-environment-variables.rst diff --git a/doc/source/docker/tutorial-deploy-on-multiple-machines.rst b/framework/docs/source/docker/tutorial-deploy-on-multiple-machines.rst similarity index 100% rename from doc/source/docker/tutorial-deploy-on-multiple-machines.rst rename to framework/docs/source/docker/tutorial-deploy-on-multiple-machines.rst diff --git a/doc/source/docker/tutorial-quickstart-docker-compose.rst b/framework/docs/source/docker/tutorial-quickstart-docker-compose.rst similarity index 100% rename from doc/source/docker/tutorial-quickstart-docker-compose.rst rename to framework/docs/source/docker/tutorial-quickstart-docker-compose.rst diff --git a/doc/source/docker/tutorial-quickstart-docker.rst b/framework/docs/source/docker/tutorial-quickstart-docker.rst similarity index 100% rename from doc/source/docker/tutorial-quickstart-docker.rst rename to framework/docs/source/docker/tutorial-quickstart-docker.rst diff --git a/doc/source/docker/use-a-different-version.rst b/framework/docs/source/docker/use-a-different-version.rst similarity index 100% rename from doc/source/docker/use-a-different-version.rst rename to framework/docs/source/docker/use-a-different-version.rst diff --git a/doc/source/explanation-differential-privacy.rst b/framework/docs/source/explanation-differential-privacy.rst similarity index 100% rename from doc/source/explanation-differential-privacy.rst rename to framework/docs/source/explanation-differential-privacy.rst diff --git a/doc/source/explanation-federated-evaluation.rst b/framework/docs/source/explanation-federated-evaluation.rst similarity index 100% rename from doc/source/explanation-federated-evaluation.rst rename to framework/docs/source/explanation-federated-evaluation.rst diff --git a/doc/source/explanation-flower-architecture.rst b/framework/docs/source/explanation-flower-architecture.rst similarity index 100% rename from doc/source/explanation-flower-architecture.rst rename to framework/docs/source/explanation-flower-architecture.rst diff --git a/doc/source/how-to-aggregate-evaluation-results.rst b/framework/docs/source/how-to-aggregate-evaluation-results.rst similarity index 100% rename from doc/source/how-to-aggregate-evaluation-results.rst rename to framework/docs/source/how-to-aggregate-evaluation-results.rst diff --git a/doc/source/how-to-authenticate-supernodes.rst b/framework/docs/source/how-to-authenticate-supernodes.rst similarity index 100% rename from doc/source/how-to-authenticate-supernodes.rst rename to framework/docs/source/how-to-authenticate-supernodes.rst diff --git a/doc/source/how-to-configure-clients.rst b/framework/docs/source/how-to-configure-clients.rst similarity index 100% rename from doc/source/how-to-configure-clients.rst rename to framework/docs/source/how-to-configure-clients.rst diff --git a/doc/source/how-to-design-stateful-clients.rst b/framework/docs/source/how-to-design-stateful-clients.rst similarity index 100% rename from doc/source/how-to-design-stateful-clients.rst rename to framework/docs/source/how-to-design-stateful-clients.rst diff --git a/doc/source/how-to-enable-tls-connections.rst b/framework/docs/source/how-to-enable-tls-connections.rst similarity index 100% rename from doc/source/how-to-enable-tls-connections.rst rename to framework/docs/source/how-to-enable-tls-connections.rst diff --git a/doc/source/how-to-implement-fedbn.rst b/framework/docs/source/how-to-implement-fedbn.rst similarity index 100% rename from doc/source/how-to-implement-fedbn.rst rename to framework/docs/source/how-to-implement-fedbn.rst diff --git a/doc/source/how-to-implement-strategies.rst b/framework/docs/source/how-to-implement-strategies.rst similarity index 100% rename from doc/source/how-to-implement-strategies.rst rename to framework/docs/source/how-to-implement-strategies.rst diff --git a/doc/source/how-to-install-flower.rst b/framework/docs/source/how-to-install-flower.rst similarity index 100% rename from doc/source/how-to-install-flower.rst rename to framework/docs/source/how-to-install-flower.rst diff --git a/doc/source/how-to-run-flower-on-azure.rst b/framework/docs/source/how-to-run-flower-on-azure.rst similarity index 100% rename from doc/source/how-to-run-flower-on-azure.rst rename to framework/docs/source/how-to-run-flower-on-azure.rst diff --git a/doc/source/how-to-run-simulations.rst b/framework/docs/source/how-to-run-simulations.rst similarity index 100% rename from doc/source/how-to-run-simulations.rst rename to framework/docs/source/how-to-run-simulations.rst diff --git a/doc/source/how-to-save-and-load-model-checkpoints.rst b/framework/docs/source/how-to-save-and-load-model-checkpoints.rst similarity index 100% rename from doc/source/how-to-save-and-load-model-checkpoints.rst rename to framework/docs/source/how-to-save-and-load-model-checkpoints.rst diff --git a/doc/source/how-to-upgrade-to-flower-1.0.rst b/framework/docs/source/how-to-upgrade-to-flower-1.0.rst similarity index 100% rename from doc/source/how-to-upgrade-to-flower-1.0.rst rename to framework/docs/source/how-to-upgrade-to-flower-1.0.rst diff --git a/doc/source/how-to-upgrade-to-flower-1.13.rst b/framework/docs/source/how-to-upgrade-to-flower-1.13.rst similarity index 100% rename from doc/source/how-to-upgrade-to-flower-1.13.rst rename to framework/docs/source/how-to-upgrade-to-flower-1.13.rst diff --git a/doc/source/how-to-use-built-in-mods.rst b/framework/docs/source/how-to-use-built-in-mods.rst similarity index 100% rename from doc/source/how-to-use-built-in-mods.rst rename to framework/docs/source/how-to-use-built-in-mods.rst diff --git a/doc/source/how-to-use-differential-privacy.rst b/framework/docs/source/how-to-use-differential-privacy.rst similarity index 100% rename from doc/source/how-to-use-differential-privacy.rst rename to framework/docs/source/how-to-use-differential-privacy.rst diff --git a/doc/source/how-to-use-strategies.rst b/framework/docs/source/how-to-use-strategies.rst similarity index 100% rename from doc/source/how-to-use-strategies.rst rename to framework/docs/source/how-to-use-strategies.rst diff --git a/doc/source/index.rst b/framework/docs/source/index.rst similarity index 100% rename from doc/source/index.rst rename to framework/docs/source/index.rst diff --git a/doc/source/ref-api-cli.rst b/framework/docs/source/ref-api-cli.rst similarity index 100% rename from doc/source/ref-api-cli.rst rename to framework/docs/source/ref-api-cli.rst diff --git a/doc/source/ref-changelog.md b/framework/docs/source/ref-changelog.md similarity index 100% rename from doc/source/ref-changelog.md rename to framework/docs/source/ref-changelog.md diff --git a/doc/source/ref-example-projects.rst b/framework/docs/source/ref-example-projects.rst similarity index 100% rename from doc/source/ref-example-projects.rst rename to framework/docs/source/ref-example-projects.rst diff --git a/doc/source/ref-faq.rst b/framework/docs/source/ref-faq.rst similarity index 100% rename from doc/source/ref-faq.rst rename to framework/docs/source/ref-faq.rst diff --git a/doc/source/ref-telemetry.md b/framework/docs/source/ref-telemetry.md similarity index 100% rename from doc/source/ref-telemetry.md rename to framework/docs/source/ref-telemetry.md diff --git a/doc/source/tutorial-quickstart-android.rst b/framework/docs/source/tutorial-quickstart-android.rst similarity index 100% rename from doc/source/tutorial-quickstart-android.rst rename to framework/docs/source/tutorial-quickstart-android.rst diff --git a/doc/source/tutorial-quickstart-fastai.rst b/framework/docs/source/tutorial-quickstart-fastai.rst similarity index 100% rename from doc/source/tutorial-quickstart-fastai.rst rename to framework/docs/source/tutorial-quickstart-fastai.rst diff --git a/doc/source/tutorial-quickstart-huggingface.rst b/framework/docs/source/tutorial-quickstart-huggingface.rst similarity index 100% rename from doc/source/tutorial-quickstart-huggingface.rst rename to framework/docs/source/tutorial-quickstart-huggingface.rst diff --git a/doc/source/tutorial-quickstart-ios.rst b/framework/docs/source/tutorial-quickstart-ios.rst similarity index 100% rename from doc/source/tutorial-quickstart-ios.rst rename to framework/docs/source/tutorial-quickstart-ios.rst diff --git a/doc/source/tutorial-quickstart-jax.rst b/framework/docs/source/tutorial-quickstart-jax.rst similarity index 100% rename from doc/source/tutorial-quickstart-jax.rst rename to framework/docs/source/tutorial-quickstart-jax.rst diff --git a/doc/source/tutorial-quickstart-mlx.rst b/framework/docs/source/tutorial-quickstart-mlx.rst similarity index 100% rename from doc/source/tutorial-quickstart-mlx.rst rename to framework/docs/source/tutorial-quickstart-mlx.rst diff --git a/doc/source/tutorial-quickstart-pandas.rst b/framework/docs/source/tutorial-quickstart-pandas.rst similarity index 100% rename from doc/source/tutorial-quickstart-pandas.rst rename to framework/docs/source/tutorial-quickstart-pandas.rst diff --git a/doc/source/tutorial-quickstart-pytorch-lightning.rst b/framework/docs/source/tutorial-quickstart-pytorch-lightning.rst similarity index 100% rename from doc/source/tutorial-quickstart-pytorch-lightning.rst rename to framework/docs/source/tutorial-quickstart-pytorch-lightning.rst diff --git a/doc/source/tutorial-quickstart-pytorch.rst b/framework/docs/source/tutorial-quickstart-pytorch.rst similarity index 100% rename from doc/source/tutorial-quickstart-pytorch.rst rename to framework/docs/source/tutorial-quickstart-pytorch.rst diff --git a/doc/source/tutorial-quickstart-scikitlearn.rst b/framework/docs/source/tutorial-quickstart-scikitlearn.rst similarity index 100% rename from doc/source/tutorial-quickstart-scikitlearn.rst rename to framework/docs/source/tutorial-quickstart-scikitlearn.rst diff --git a/doc/source/tutorial-quickstart-tensorflow.rst b/framework/docs/source/tutorial-quickstart-tensorflow.rst similarity index 100% rename from doc/source/tutorial-quickstart-tensorflow.rst rename to framework/docs/source/tutorial-quickstart-tensorflow.rst diff --git a/doc/source/tutorial-quickstart-xgboost.rst b/framework/docs/source/tutorial-quickstart-xgboost.rst similarity index 100% rename from doc/source/tutorial-quickstart-xgboost.rst rename to framework/docs/source/tutorial-quickstart-xgboost.rst diff --git a/doc/source/tutorial-series-build-a-strategy-from-scratch-pytorch.ipynb b/framework/docs/source/tutorial-series-build-a-strategy-from-scratch-pytorch.ipynb similarity index 100% rename from doc/source/tutorial-series-build-a-strategy-from-scratch-pytorch.ipynb rename to framework/docs/source/tutorial-series-build-a-strategy-from-scratch-pytorch.ipynb diff --git a/doc/source/tutorial-series-customize-the-client-pytorch.ipynb b/framework/docs/source/tutorial-series-customize-the-client-pytorch.ipynb similarity index 100% rename from doc/source/tutorial-series-customize-the-client-pytorch.ipynb rename to framework/docs/source/tutorial-series-customize-the-client-pytorch.ipynb diff --git a/doc/source/tutorial-series-get-started-with-flower-pytorch.ipynb b/framework/docs/source/tutorial-series-get-started-with-flower-pytorch.ipynb similarity index 100% rename from doc/source/tutorial-series-get-started-with-flower-pytorch.ipynb rename to framework/docs/source/tutorial-series-get-started-with-flower-pytorch.ipynb diff --git a/doc/source/tutorial-series-use-a-federated-learning-strategy-pytorch.ipynb b/framework/docs/source/tutorial-series-use-a-federated-learning-strategy-pytorch.ipynb similarity index 100% rename from doc/source/tutorial-series-use-a-federated-learning-strategy-pytorch.ipynb rename to framework/docs/source/tutorial-series-use-a-federated-learning-strategy-pytorch.ipynb diff --git a/doc/source/tutorial-series-what-is-federated-learning.ipynb b/framework/docs/source/tutorial-series-what-is-federated-learning.ipynb similarity index 100% rename from doc/source/tutorial-series-what-is-federated-learning.ipynb rename to framework/docs/source/tutorial-series-what-is-federated-learning.ipynb diff --git a/pyproject.toml b/pyproject.toml index f1207a94c448..1636010a471e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -144,10 +144,10 @@ docsig = "==0.64.0" [tool.docstrfmt] extend_exclude = [ - "doc/source/conf.py", - "doc/source/tutorial-quickstart-huggingface.rst", - "doc/source/_templates/autosummary/*", - "doc/source/ref-api/*", + "framework/docs/source/conf.py", + "framework/docs/source/tutorial-quickstart-huggingface.rst", + "framework/docs/source/_templates/autosummary/*", + "framework/docs/source/ref-api/*", ] [tool.isort]