docs(framework) Move framework docs to framework/docs (#4655)

Co-authored-by: Daniel J. Beutel <[email protected]>
adap · Dec 9, 2024 · 069c186 · 069c186
1 parent 396a68c
commit 069c186
Show file tree

Hide file tree

Showing 145 changed files with 19 additions and 19 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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 → framework/docs/Makefile b/doc/Makefile → framework/docs/Makefile
diff --git a/doc/build-versioned-docs.sh → framework/docs/build-versioned-docs.sh b/doc/build-versioned-docs.sh → framework/docs/build-versioned-docs.sh
diff --git a/doc/locales/fr/LC_MESSAGES/framework-docs.po → .../locales/fr/LC_MESSAGES/framework-docs.po b/doc/locales/fr/LC_MESSAGES/framework-docs.po → .../locales/fr/LC_MESSAGES/framework-docs.po
diff --git a/doc/locales/fr/LC_MESSAGES/sphinx.po → ...ork/docs/locales/fr/LC_MESSAGES/sphinx.po b/doc/locales/fr/LC_MESSAGES/sphinx.po → ...ork/docs/locales/fr/LC_MESSAGES/sphinx.po
diff --git a/doc/locales/ko/LC_MESSAGES/framework-docs.po → .../locales/ko/LC_MESSAGES/framework-docs.po b/doc/locales/ko/LC_MESSAGES/framework-docs.po → .../locales/ko/LC_MESSAGES/framework-docs.po
diff --git a/doc/locales/ko/LC_MESSAGES/sphinx.po → ...ork/docs/locales/ko/LC_MESSAGES/sphinx.po b/doc/locales/ko/LC_MESSAGES/sphinx.po → ...ork/docs/locales/ko/LC_MESSAGES/sphinx.po
diff --git a/...cales/pt_BR/LC_MESSAGES/framework-docs.po → ...cales/pt_BR/LC_MESSAGES/framework-docs.po b/...cales/pt_BR/LC_MESSAGES/framework-docs.po → ...cales/pt_BR/LC_MESSAGES/framework-docs.po
diff --git a/doc/locales/pt_BR/LC_MESSAGES/sphinx.po → .../docs/locales/pt_BR/LC_MESSAGES/sphinx.po b/doc/locales/pt_BR/LC_MESSAGES/sphinx.po → .../docs/locales/pt_BR/LC_MESSAGES/sphinx.po
diff --git a/...les/zh_Hans/LC_MESSAGES/framework-docs.po → ...les/zh_Hans/LC_MESSAGES/framework-docs.po b/...les/zh_Hans/LC_MESSAGES/framework-docs.po → ...les/zh_Hans/LC_MESSAGES/framework-docs.po
diff --git a/doc/locales/zh_Hans/LC_MESSAGES/sphinx.po → ...ocs/locales/zh_Hans/LC_MESSAGES/sphinx.po b/doc/locales/zh_Hans/LC_MESSAGES/sphinx.po → ...ocs/locales/zh_Hans/LC_MESSAGES/sphinx.po
diff --git a/doc/make.bat → framework/docs/make.bat b/doc/make.bat → framework/docs/make.bat
diff --git a/doc/source/.gitignore → framework/docs/source/.gitignore b/doc/source/.gitignore → framework/docs/source/.gitignore
diff --git a/doc/source/_static/DP/CDP.png → framework/docs/source/_static/DP/CDP.png b/doc/source/_static/DP/CDP.png → framework/docs/source/_static/DP/CDP.png
diff --git a/doc/source/_static/DP/LDP.png → framework/docs/source/_static/DP/LDP.png b/doc/source/_static/DP/LDP.png → framework/docs/source/_static/DP/LDP.png
diff --git a/doc/source/_static/DP/clientsideCDP.png → .../docs/source/_static/DP/clientsideCDP.png b/doc/source/_static/DP/clientsideCDP.png → .../docs/source/_static/DP/clientsideCDP.png
diff --git a/doc/source/_static/DP/clipping.png → ...ework/docs/source/_static/DP/clipping.png b/doc/source/_static/DP/clipping.png → ...ework/docs/source/_static/DP/clipping.png
diff --git a/doc/source/_static/DP/dp-intro.png → ...ework/docs/source/_static/DP/dp-intro.png b/doc/source/_static/DP/dp-intro.png → ...ework/docs/source/_static/DP/dp-intro.png
diff --git a/doc/source/_static/DP/localdp.png → framework/docs/source/_static/DP/localdp.png b/doc/source/_static/DP/localdp.png → framework/docs/source/_static/DP/localdp.png
diff --git a/doc/source/_static/DP/serversideCDP.png → .../docs/source/_static/DP/serversideCDP.png b/doc/source/_static/DP/serversideCDP.png → .../docs/source/_static/DP/serversideCDP.png
diff --git a/doc/source/_static/changes_requested.png → ...docs/source/_static/changes_requested.png b/doc/source/_static/changes_requested.png → ...docs/source/_static/changes_requested.png
diff --git a/doc/source/_static/cloning_fork.png → ...work/docs/source/_static/cloning_fork.png b/doc/source/_static/cloning_fork.png → ...work/docs/source/_static/cloning_fork.png
diff --git a/doc/source/_static/cloning_repo.png → ...work/docs/source/_static/cloning_repo.png b/doc/source/_static/cloning_repo.png → ...work/docs/source/_static/cloning_repo.png
diff --git a/doc/source/_static/compare_and_pr.png → ...rk/docs/source/_static/compare_and_pr.png b/doc/source/_static/compare_and_pr.png → ...rk/docs/source/_static/compare_and_pr.png
diff --git a/doc/source/_static/creating_pr.png → ...ework/docs/source/_static/creating_pr.png b/doc/source/_static/creating_pr.png → ...ework/docs/source/_static/creating_pr.png
diff --git a/doc/source/_static/custom.css → framework/docs/source/_static/custom.css b/doc/source/_static/custom.css → framework/docs/source/_static/custom.css
diff --git a/doc/source/_static/draft_pr.png → framework/docs/source/_static/draft_pr.png b/doc/source/_static/draft_pr.png → framework/docs/source/_static/draft_pr.png
diff --git a/doc/source/_static/favicon.ico → framework/docs/source/_static/favicon.ico b/doc/source/_static/favicon.ico → framework/docs/source/_static/favicon.ico
diff --git a/doc/source/_static/flower-actors.drawio.png → ...s/source/_static/flower-actors.drawio.png b/doc/source/_static/flower-actors.drawio.png → ...s/source/_static/flower-actors.drawio.png
diff --git a/...lower-architecture-basic-architecture.svg → ...lower-architecture-basic-architecture.svg b/...lower-architecture-basic-architecture.svg → ...lower-architecture-basic-architecture.svg
diff --git a/...tic/flower-architecture-hub-and-spoke.svg → ...tic/flower-architecture-hub-and-spoke.svg b/...tic/flower-architecture-hub-and-spoke.svg → ...tic/flower-architecture-hub-and-spoke.svg
diff --git a/...tatic/flower-architecture-multi-run-1.svg → ...tatic/flower-architecture-multi-run-1.svg b/...tatic/flower-architecture-multi-run-1.svg → ...tatic/flower-architecture-multi-run-1.svg
diff --git a/...tatic/flower-architecture-multi-run-2.svg → ...tatic/flower-architecture-multi-run-2.svg b/...tatic/flower-architecture-multi-run-2.svg → ...tatic/flower-architecture-multi-run-2.svg
diff --git a/..._static/flower-architecture-multi-run.svg → ..._static/flower-architecture-multi-run.svg b/..._static/flower-architecture-multi-run.svg → ..._static/flower-architecture-multi-run.svg
diff --git a/doc/source/_static/flower-logo.png → ...ework/docs/source/_static/flower-logo.png b/doc/source/_static/flower-logo.png → ...ework/docs/source/_static/flower-logo.png
diff --git a/doc/source/_static/fork_button.png → ...ework/docs/source/_static/fork_button.png b/doc/source/_static/fork_button.png → ...ework/docs/source/_static/fork_button.png
diff --git a/doc/source/_static/fork_link.png → framework/docs/source/_static/fork_link.png b/doc/source/_static/fork_link.png → framework/docs/source/_static/fork_link.png
diff --git a/doc/source/_static/forking-repo.png → ...work/docs/source/_static/forking-repo.png b/doc/source/_static/forking-repo.png → ...work/docs/source/_static/forking-repo.png
diff --git a/doc/source/_static/github_schema.png → ...ork/docs/source/_static/github_schema.png b/doc/source/_static/github_schema.png → ...ork/docs/source/_static/github_schema.png
diff --git a/doc/source/_static/make_changes.png → ...work/docs/source/_static/make_changes.png b/doc/source/_static/make_changes.png → ...work/docs/source/_static/make_changes.png
diff --git a/doc/source/_static/merging_branch.png → ...rk/docs/source/_static/merging_branch.png b/doc/source/_static/merging_branch.png → ...rk/docs/source/_static/merging_branch.png
diff --git a/doc/source/_static/merging_pr.png → framework/docs/source/_static/merging_pr.png b/doc/source/_static/merging_pr.png → framework/docs/source/_static/merging_pr.png
diff --git a/doc/source/_static/opened_pr.png → framework/docs/source/_static/opened_pr.png b/doc/source/_static/opened_pr.png → framework/docs/source/_static/opened_pr.png
diff --git a/doc/source/_static/opening-pr.png → framework/docs/source/_static/opening-pr.png b/doc/source/_static/opening-pr.png → framework/docs/source/_static/opening-pr.png
diff --git a/doc/source/_static/resolve_conv.png → ...work/docs/source/_static/resolve_conv.png b/doc/source/_static/resolve_conv.png → ...work/docs/source/_static/resolve_conv.png
diff --git a/...tatic/tutorial/central-model-training.png → ...tatic/tutorial/central-model-training.png b/...tatic/tutorial/central-model-training.png → ...tatic/tutorial/central-model-training.png
diff --git a/...tatic/tutorial/centralized-impossible.png → ...tatic/tutorial/centralized-impossible.png b/...tatic/tutorial/centralized-impossible.png → ...tatic/tutorial/centralized-impossible.png
diff --git a/..._static/tutorial/centralized-possible.png → ..._static/tutorial/centralized-possible.png b/..._static/tutorial/centralized-possible.png → ..._static/tutorial/centralized-possible.png
diff --git a/doc/source/_static/tutorial/collect-data.png → .../source/_static/tutorial/collect-data.png b/doc/source/_static/tutorial/collect-data.png → .../source/_static/tutorial/collect-data.png
diff --git a/...source/_static/tutorial/data-on-phone.png → ...source/_static/tutorial/data-on-phone.png b/...source/_static/tutorial/data-on-phone.png → ...source/_static/tutorial/data-on-phone.png
diff --git a/...c/tutorial/fl-aggregate-model-updates.png → ...c/tutorial/fl-aggregate-model-updates.png b/...c/tutorial/fl-aggregate-model-updates.png → ...c/tutorial/fl-aggregate-model-updates.png
diff --git a/...c/tutorial/fl-initialize-global-model.png → ...c/tutorial/fl-initialize-global-model.png b/...c/tutorial/fl-initialize-global-model.png → ...c/tutorial/fl-initialize-global-model.png
diff --git a/...ce/_static/tutorial/fl-local-training.png → ...ce/_static/tutorial/fl-local-training.png b/...ce/_static/tutorial/fl-local-training.png → ...ce/_static/tutorial/fl-local-training.png
diff --git a/..._static/tutorial/fl-send-global-model.png → ..._static/tutorial/fl-send-global-model.png b/..._static/tutorial/fl-send-global-model.png → ..._static/tutorial/fl-send-global-model.png
diff --git a/...static/tutorial/fl-send-model-updates.png → ...static/tutorial/fl-send-model-updates.png b/...static/tutorial/fl-send-model-updates.png → ...static/tutorial/fl-send-model-updates.png
diff --git a/doc/source/_static/tutorial/flower-any.jpeg → ...s/source/_static/tutorial/flower-any.jpeg b/doc/source/_static/tutorial/flower-any.jpeg → ...s/source/_static/tutorial/flower-any.jpeg
diff --git a/...tatic/tutorial/many-devices-with-data.png → ...tatic/tutorial/many-devices-with-data.png b/...tatic/tutorial/many-devices-with-data.png → ...tatic/tutorial/many-devices-with-data.png
diff --git a/...ource/_static/tutorial/model-and-data.png → ...ource/_static/tutorial/model-and-data.png b/...ource/_static/tutorial/model-and-data.png → ...ource/_static/tutorial/model-and-data.png
diff --git a/doc/source/_static/tutorial/train-model.png → ...s/source/_static/tutorial/train-model.png b/doc/source/_static/tutorial/train-model.png → ...s/source/_static/tutorial/train-model.png
diff --git a/doc/source/_static/upstream_link.png → ...ork/docs/source/_static/upstream_link.png b/doc/source/_static/upstream_link.png → ...ork/docs/source/_static/upstream_link.png
diff --git a/doc/source/_static/weblate_interface.png → ...docs/source/_static/weblate_interface.png b/doc/source/_static/weblate_interface.png → ...docs/source/_static/weblate_interface.png
diff --git a/doc/source/_static/weblate_status.png → ...rk/docs/source/_static/weblate_status.png b/doc/source/_static/weblate_status.png → ...rk/docs/source/_static/weblate_status.png
diff --git a/doc/source/_templates/autosummary/base.rst → ...cs/source/_templates/autosummary/base.rst b/doc/source/_templates/autosummary/base.rst → ...cs/source/_templates/autosummary/base.rst
diff --git a/doc/source/_templates/autosummary/class.rst → ...s/source/_templates/autosummary/class.rst b/doc/source/_templates/autosummary/class.rst → ...s/source/_templates/autosummary/class.rst
diff --git a/doc/source/_templates/autosummary/module.rst → .../source/_templates/autosummary/module.rst b/doc/source/_templates/autosummary/module.rst → .../source/_templates/autosummary/module.rst
diff --git a/doc/source/_templates/base.html → framework/docs/source/_templates/base.html b/doc/source/_templates/base.html → framework/docs/source/_templates/base.html
diff --git a/doc/source/_templates/sidebar/brand.html → ...docs/source/_templates/sidebar/brand.html b/doc/source/_templates/sidebar/brand.html → ...docs/source/_templates/sidebar/brand.html
diff --git a/doc/source/_templates/sidebar/lang.html → .../docs/source/_templates/sidebar/lang.html b/doc/source/_templates/sidebar/lang.html → .../docs/source/_templates/sidebar/lang.html
diff --git a/doc/source/_templates/sidebar/search.html → ...ocs/source/_templates/sidebar/search.html b/doc/source/_templates/sidebar/search.html → ...ocs/source/_templates/sidebar/search.html
diff --git a/...source/_templates/sidebar/versioning.html → ...source/_templates/sidebar/versioning.html b/...source/_templates/sidebar/versioning.html → ...source/_templates/sidebar/versioning.html
diff --git a/doc/source/conf.py → framework/docs/source/conf.py b/doc/source/conf.py → framework/docs/source/conf.py
diff --git a/...r-explanation-public-and-private-apis.rst → ...r-explanation-public-and-private-apis.rst b/...r-explanation-public-and-private-apis.rst → ...r-explanation-public-and-private-apis.rst
diff --git a/...ontributor-how-to-build-docker-images.rst → ...ontributor-how-to-build-docker-images.rst b/...ontributor-how-to-build-docker-images.rst → ...ontributor-how-to-build-docker-images.rst
diff --git a/...ibutor-how-to-contribute-translations.rst → ...ibutor-how-to-contribute-translations.rst b/...ibutor-how-to-contribute-translations.rst → ...ibutor-how-to-contribute-translations.rst
diff --git a/...w-to-develop-in-vscode-dev-containers.rst → ...w-to-develop-in-vscode-dev-containers.rst b/...w-to-develop-in-vscode-dev-containers.rst → ...w-to-develop-in-vscode-dev-containers.rst
diff --git a/...r-how-to-install-development-versions.rst → ...r-how-to-install-development-versions.rst b/...r-how-to-install-development-versions.rst → ...r-how-to-install-development-versions.rst
diff --git a/...rce/contributor-how-to-release-flower.rst → ...rce/contributor-how-to-release-flower.rst b/...rce/contributor-how-to-release-flower.rst → ...rce/contributor-how-to-release-flower.rst
diff --git a/...ntributor-how-to-set-up-a-virtual-env.rst → ...ntributor-how-to-set-up-a-virtual-env.rst b/...ntributor-how-to-set-up-a-virtual-env.rst → ...ntributor-how-to-set-up-a-virtual-env.rst
diff --git a/...ontributor-how-to-write-documentation.rst → ...ontributor-how-to-write-documentation.rst b/...ontributor-how-to-write-documentation.rst → ...ontributor-how-to-write-documentation.rst
diff --git a/...tributor-ref-good-first-contributions.rst → ...tributor-ref-good-first-contributions.rst b/...tributor-ref-good-first-contributions.rst → ...tributor-ref-good-first-contributions.rst
diff --git a/...utor-ref-secure-aggregation-protocols.rst → ...utor-ref-secure-aggregation-protocols.rst b/...utor-ref-secure-aggregation-protocols.rst → ...utor-ref-secure-aggregation-protocols.rst
diff --git a/...ributor-tutorial-contribute-on-github.rst → ...ributor-tutorial-contribute-on-github.rst b/...ributor-tutorial-contribute-on-github.rst → ...ributor-tutorial-contribute-on-github.rst
diff --git a/...tutorial-get-started-as-a-contributor.rst → ...tutorial-get-started-as-a-contributor.rst b/...tutorial-get-started-as-a-contributor.rst → ...tutorial-get-started-as-a-contributor.rst
diff --git a/doc/source/docker/enable-tls.rst → framework/docs/source/docker/enable-tls.rst b/doc/source/docker/enable-tls.rst → framework/docs/source/docker/enable-tls.rst
diff --git a/doc/source/docker/index.rst → framework/docs/source/docker/index.rst b/doc/source/docker/index.rst → framework/docs/source/docker/index.rst
diff --git a/...source/docker/persist-superlink-state.rst → ...source/docker/persist-superlink-state.rst b/...source/docker/persist-superlink-state.rst → ...source/docker/persist-superlink-state.rst
diff --git a/doc/source/docker/pin-version.rst → framework/docs/source/docker/pin-version.rst b/doc/source/docker/pin-version.rst → framework/docs/source/docker/pin-version.rst
diff --git a/doc/source/docker/run-as-root-user.rst → ...k/docs/source/docker/run-as-root-user.rst b/doc/source/docker/run-as-root-user.rst → ...k/docs/source/docker/run-as-root-user.rst
diff --git a/doc/source/docker/run-as-subprocess.rst → .../docs/source/docker/run-as-subprocess.rst b/doc/source/docker/run-as-subprocess.rst → .../docs/source/docker/run-as-subprocess.rst
diff --git a/...un-quickstart-examples-docker-compose.rst → ...un-quickstart-examples-docker-compose.rst b/...un-quickstart-examples-docker-compose.rst → ...un-quickstart-examples-docker-compose.rst
diff --git a/...urce/docker/set-environment-variables.rst → ...urce/docker/set-environment-variables.rst b/...urce/docker/set-environment-variables.rst → ...urce/docker/set-environment-variables.rst
diff --git a/.../tutorial-deploy-on-multiple-machines.rst → .../tutorial-deploy-on-multiple-machines.rst b/.../tutorial-deploy-on-multiple-machines.rst → .../tutorial-deploy-on-multiple-machines.rst
diff --git a/...er/tutorial-quickstart-docker-compose.rst → ...er/tutorial-quickstart-docker-compose.rst b/...er/tutorial-quickstart-docker-compose.rst → ...er/tutorial-quickstart-docker-compose.rst
diff --git a/...rce/docker/tutorial-quickstart-docker.rst → ...rce/docker/tutorial-quickstart-docker.rst b/...rce/docker/tutorial-quickstart-docker.rst → ...rce/docker/tutorial-quickstart-docker.rst
diff --git a/...source/docker/use-a-different-version.rst → ...source/docker/use-a-different-version.rst b/...source/docker/use-a-different-version.rst → ...source/docker/use-a-different-version.rst
diff --git a/...urce/explanation-differential-privacy.rst → ...urce/explanation-differential-privacy.rst b/...urce/explanation-differential-privacy.rst → ...urce/explanation-differential-privacy.rst
diff --git a/...urce/explanation-federated-evaluation.rst → ...urce/explanation-federated-evaluation.rst b/...urce/explanation-federated-evaluation.rst → ...urce/explanation-federated-evaluation.rst
diff --git a/...ource/explanation-flower-architecture.rst → ...ource/explanation-flower-architecture.rst b/...ource/explanation-flower-architecture.rst → ...ource/explanation-flower-architecture.rst
diff --git a/...e/how-to-aggregate-evaluation-results.rst → ...e/how-to-aggregate-evaluation-results.rst b/...e/how-to-aggregate-evaluation-results.rst → ...e/how-to-aggregate-evaluation-results.rst
diff --git a/...source/how-to-authenticate-supernodes.rst → ...source/how-to-authenticate-supernodes.rst b/...source/how-to-authenticate-supernodes.rst → ...source/how-to-authenticate-supernodes.rst
diff --git a/doc/source/how-to-configure-clients.rst → .../docs/source/how-to-configure-clients.rst b/doc/source/how-to-configure-clients.rst → .../docs/source/how-to-configure-clients.rst
diff --git a/...source/how-to-design-stateful-clients.rst → ...source/how-to-design-stateful-clients.rst b/...source/how-to-design-stateful-clients.rst → ...source/how-to-design-stateful-clients.rst
diff --git a/doc/source/how-to-enable-tls-connections.rst → .../source/how-to-enable-tls-connections.rst b/doc/source/how-to-enable-tls-connections.rst → .../source/how-to-enable-tls-connections.rst
diff --git a/doc/source/how-to-implement-fedbn.rst → ...rk/docs/source/how-to-implement-fedbn.rst b/doc/source/how-to-implement-fedbn.rst → ...rk/docs/source/how-to-implement-fedbn.rst
diff --git a/doc/source/how-to-implement-strategies.rst → ...cs/source/how-to-implement-strategies.rst b/doc/source/how-to-implement-strategies.rst → ...cs/source/how-to-implement-strategies.rst
diff --git a/doc/source/how-to-install-flower.rst → ...ork/docs/source/how-to-install-flower.rst b/doc/source/how-to-install-flower.rst → ...ork/docs/source/how-to-install-flower.rst
diff --git a/doc/source/how-to-run-flower-on-azure.rst → ...ocs/source/how-to-run-flower-on-azure.rst b/doc/source/how-to-run-flower-on-azure.rst → ...ocs/source/how-to-run-flower-on-azure.rst
diff --git a/doc/source/how-to-run-simulations.rst → ...rk/docs/source/how-to-run-simulations.rst b/doc/source/how-to-run-simulations.rst → ...rk/docs/source/how-to-run-simulations.rst
diff --git a/...ow-to-save-and-load-model-checkpoints.rst → ...ow-to-save-and-load-model-checkpoints.rst b/...ow-to-save-and-load-model-checkpoints.rst → ...ow-to-save-and-load-model-checkpoints.rst
diff --git a/doc/source/how-to-upgrade-to-flower-1.0.rst → ...s/source/how-to-upgrade-to-flower-1.0.rst b/doc/source/how-to-upgrade-to-flower-1.0.rst → ...s/source/how-to-upgrade-to-flower-1.0.rst
diff --git a/doc/source/how-to-upgrade-to-flower-1.13.rst → .../source/how-to-upgrade-to-flower-1.13.rst b/doc/source/how-to-upgrade-to-flower-1.13.rst → .../source/how-to-upgrade-to-flower-1.13.rst
diff --git a/doc/source/how-to-use-built-in-mods.rst → .../docs/source/how-to-use-built-in-mods.rst b/doc/source/how-to-use-built-in-mods.rst → .../docs/source/how-to-use-built-in-mods.rst
diff --git a/...ource/how-to-use-differential-privacy.rst → ...ource/how-to-use-differential-privacy.rst b/...ource/how-to-use-differential-privacy.rst → ...ource/how-to-use-differential-privacy.rst
diff --git a/doc/source/how-to-use-strategies.rst → ...ork/docs/source/how-to-use-strategies.rst b/doc/source/how-to-use-strategies.rst → ...ork/docs/source/how-to-use-strategies.rst
diff --git a/doc/source/index.rst → framework/docs/source/index.rst b/doc/source/index.rst → framework/docs/source/index.rst
diff --git a/doc/source/ref-api-cli.rst → framework/docs/source/ref-api-cli.rst b/doc/source/ref-api-cli.rst → framework/docs/source/ref-api-cli.rst
diff --git a/doc/source/ref-changelog.md → framework/docs/source/ref-changelog.md b/doc/source/ref-changelog.md → framework/docs/source/ref-changelog.md
diff --git a/doc/source/ref-example-projects.rst → ...work/docs/source/ref-example-projects.rst b/doc/source/ref-example-projects.rst → ...work/docs/source/ref-example-projects.rst
diff --git a/doc/source/ref-faq.rst → framework/docs/source/ref-faq.rst b/doc/source/ref-faq.rst → framework/docs/source/ref-faq.rst
diff --git a/doc/source/ref-telemetry.md → framework/docs/source/ref-telemetry.md b/doc/source/ref-telemetry.md → framework/docs/source/ref-telemetry.md
diff --git a/doc/source/tutorial-quickstart-android.rst → ...cs/source/tutorial-quickstart-android.rst b/doc/source/tutorial-quickstart-android.rst → ...cs/source/tutorial-quickstart-android.rst
diff --git a/doc/source/tutorial-quickstart-fastai.rst → ...ocs/source/tutorial-quickstart-fastai.rst b/doc/source/tutorial-quickstart-fastai.rst → ...ocs/source/tutorial-quickstart-fastai.rst
diff --git a/...ource/tutorial-quickstart-huggingface.rst → ...ource/tutorial-quickstart-huggingface.rst b/...ource/tutorial-quickstart-huggingface.rst → ...ource/tutorial-quickstart-huggingface.rst
diff --git a/doc/source/tutorial-quickstart-ios.rst → ...k/docs/source/tutorial-quickstart-ios.rst b/doc/source/tutorial-quickstart-ios.rst → ...k/docs/source/tutorial-quickstart-ios.rst
diff --git a/doc/source/tutorial-quickstart-jax.rst → ...k/docs/source/tutorial-quickstart-jax.rst b/doc/source/tutorial-quickstart-jax.rst → ...k/docs/source/tutorial-quickstart-jax.rst
diff --git a/doc/source/tutorial-quickstart-mlx.rst → ...k/docs/source/tutorial-quickstart-mlx.rst b/doc/source/tutorial-quickstart-mlx.rst → ...k/docs/source/tutorial-quickstart-mlx.rst
diff --git a/doc/source/tutorial-quickstart-pandas.rst → ...ocs/source/tutorial-quickstart-pandas.rst b/doc/source/tutorial-quickstart-pandas.rst → ...ocs/source/tutorial-quickstart-pandas.rst
diff --git a/...tutorial-quickstart-pytorch-lightning.rst → ...tutorial-quickstart-pytorch-lightning.rst b/...tutorial-quickstart-pytorch-lightning.rst → ...tutorial-quickstart-pytorch-lightning.rst
diff --git a/doc/source/tutorial-quickstart-pytorch.rst → ...cs/source/tutorial-quickstart-pytorch.rst b/doc/source/tutorial-quickstart-pytorch.rst → ...cs/source/tutorial-quickstart-pytorch.rst
diff --git a/...ource/tutorial-quickstart-scikitlearn.rst → ...ource/tutorial-quickstart-scikitlearn.rst b/...ource/tutorial-quickstart-scikitlearn.rst → ...ource/tutorial-quickstart-scikitlearn.rst
diff --git a/...source/tutorial-quickstart-tensorflow.rst → ...source/tutorial-quickstart-tensorflow.rst b/...source/tutorial-quickstart-tensorflow.rst → ...source/tutorial-quickstart-tensorflow.rst
diff --git a/doc/source/tutorial-quickstart-xgboost.rst → ...cs/source/tutorial-quickstart-xgboost.rst b/doc/source/tutorial-quickstart-xgboost.rst → ...cs/source/tutorial-quickstart-xgboost.rst
diff --git a/...ild-a-strategy-from-scratch-pytorch.ipynb → ...ild-a-strategy-from-scratch-pytorch.ipynb b/...ild-a-strategy-from-scratch-pytorch.ipynb → ...ild-a-strategy-from-scratch-pytorch.ipynb
diff --git a/...series-customize-the-client-pytorch.ipynb → ...series-customize-the-client-pytorch.ipynb b/...series-customize-the-client-pytorch.ipynb → ...series-customize-the-client-pytorch.ipynb
diff --git a/...ies-get-started-with-flower-pytorch.ipynb → ...ies-get-started-with-flower-pytorch.ipynb b/...ies-get-started-with-flower-pytorch.ipynb → ...ies-get-started-with-flower-pytorch.ipynb
diff --git a/...federated-learning-strategy-pytorch.ipynb → ...federated-learning-strategy-pytorch.ipynb b/...federated-learning-strategy-pytorch.ipynb → ...federated-learning-strategy-pytorch.ipynb
diff --git a/...l-series-what-is-federated-learning.ipynb → ...l-series-what-is-federated-learning.ipynb b/...l-series-what-is-federated-learning.ipynb → ...l-series-what-is-federated-learning.ipynb
diff --git 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]