From 554053628651978e0cd9aa8e11bc16c051066445 Mon Sep 17 00:00:00 2001 From: Charles Beauville Date: Fri, 20 Dec 2024 14:23:19 +0100 Subject: [PATCH] docs(*:skip) Update links to new path (#4754) --- CHANGELOG.md | 2 +- README.md | 2 +- baselines/docs/source/conf.py | 2 +- dev/test-copyright.sh | 2 +- dev/update_python.py | 8 ++-- examples/docs/source/conf.py | 2 +- .../locales/fr/LC_MESSAGES/framework-docs.po | 42 +++++++++---------- .../locales/ko/LC_MESSAGES/framework-docs.po | 32 +++++++------- .../pt_BR/LC_MESSAGES/framework-docs.po | 28 ++++++------- .../zh_Hans/LC_MESSAGES/framework-docs.po | 36 ++++++++-------- framework/docs/source/conf.py | 4 +- ...or-how-to-install-development-versions.rst | 7 ++-- ...contributor-how-to-write-documentation.rst | 12 +++--- ...tributor-tutorial-contribute-on-github.rst | 4 +- framework/docs/source/ref-changelog.md | 4 +- 15 files changed, 94 insertions(+), 93 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1f01c0e9717d..41e5ab74a924 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,4 +2,4 @@ Flower changes are tracked as part of the documentation: [Flower Changelog](https://flower.ai/docs/changelog.html). -The changelog source can be edited here: `doc/source/changelog.rst` +The changelog source can be edited here: `framework/docs/source/changelog.rst` diff --git a/README.md b/README.md index 30b54786244a..840d988c94e8 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ Flower's goal is to make federated learning accessible to everyone. This series 4. **Custom Clients for Federated Learning** - [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/adap/flower/blob/main/doc/source/tutorial-series-customize-the-client-pytorch.ipynb) (or open the [Jupyter Notebook](https://github.com/adap/flower/blob/main/framework/docs/source/tutorial-series-customize-the-client-pytorch.ipynb)) + [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source/tutorial-series-customize-the-client-pytorch.ipynb) (or open the [Jupyter Notebook](https://github.com/adap/flower/blob/main/framework/docs/source/tutorial-series-customize-the-client-pytorch.ipynb)) Stay tuned, more tutorials are coming soon. Topics include **Privacy and Security in Federated Learning**, and **Scaling Federated Learning**. diff --git a/baselines/docs/source/conf.py b/baselines/docs/source/conf.py index 291300f0d8bc..ccfe9b2448ca 100644 --- a/baselines/docs/source/conf.py +++ b/baselines/docs/source/conf.py @@ -122,7 +122,7 @@ colab_link = ( "https://colab.research.google.com/github/adap/flower/blob/main/" - "doc/source/{{ env.doc2path(env.docname, base=None) }}" + "framework/docs/source/{{ env.doc2path(env.docname, base=None) }}" ) _open_in_colab_button = f""" .. raw:: html diff --git a/dev/test-copyright.sh b/dev/test-copyright.sh index 5ba8fedfe1ef..e8e5a2b52c5b 100755 --- a/dev/test-copyright.sh +++ b/dev/test-copyright.sh @@ -10,6 +10,6 @@ while IFS= read -r -d '' file; do echo "::error file=$file::Wrong copyright line. Expected: copyright = f\"{datetime.date.today().year} Flower Labs GmbH\"" EXIT_CODE=1 fi -done < <(find . -path "*/doc/source/conf.py" -print0) +done < <(find . -path "*/docs/source/conf.py" -print0) exit $EXIT_CODE diff --git a/dev/update_python.py b/dev/update_python.py index 5eea6af75488..f2acd8102b07 100644 --- a/dev/update_python.py +++ b/dev/update_python.py @@ -57,7 +57,7 @@ def _update_python_versions( ), ], # Documentation files - "doc/source/conf.py": [ + "framework/docs/source/conf.py": [ # Update Python full version in conf.py ( r"(\.\.\s*\|python_full_version\|\s*replace::\s*)" @@ -143,7 +143,7 @@ def _update_python_versions( ), ], # Documentation files - "doc/source/conf.py": [ + "framework/docs/source/conf.py": [ # Update Python version in conf.py ( r"(\.\.\s*\|python_version\|\s*replace::\s*)" @@ -159,7 +159,7 @@ def _update_python_versions( ), ], # ReStructuredText files - "doc/source/*.rst": [ + "framework/docs/source/*.rst": [ # Update Python version in rst files ( r"(`Python\s*" @@ -175,7 +175,7 @@ def _update_python_versions( ), ], # PO files for localization - "doc/locales/*/LC_MESSAGES/framework-docs.po": [ + "framework/docs/locales/*/LC_MESSAGES/framework-docs.po": [ # Update Python version in localization files ( r"(`Python\s*" diff --git a/examples/docs/source/conf.py b/examples/docs/source/conf.py index 44ce268d415a..c136851cf682 100644 --- a/examples/docs/source/conf.py +++ b/examples/docs/source/conf.py @@ -121,7 +121,7 @@ .. raw:: html
- + Open in Colab """ diff --git a/framework/docs/locales/fr/LC_MESSAGES/framework-docs.po b/framework/docs/locales/fr/LC_MESSAGES/framework-docs.po index 6bf39bff3d44..6b7a36cc2b8d 100644 --- a/framework/docs/locales/fr/LC_MESSAGES/framework-docs.po +++ b/framework/docs/locales/fr/LC_MESSAGES/framework-docs.po @@ -880,19 +880,19 @@ msgstr "Ouvre les carnets Jupyter sur Google Colab" #: ../../source/contributor-how-to-install-development-versions.rst:59 #, fuzzy msgid "" -"Open the notebook ``doc/source/tutorial-series-get-started-with-flower-" +"Open the notebook ``framework/docs/source/tutorial-series-get-started-with-flower-" "pytorch.ipynb``:" msgstr "" -"Ouvrir le notebook ``doc/source/tutorial/Flower-1-Intro-to-FL-" +"Ouvrir le notebook ``framework/docs/source/tutorial/Flower-1-Intro-to-FL-" "PyTorch.ipynb`` :" #: ../../source/contributor-how-to-install-development-versions.rst:61 #, fuzzy msgid "" -"https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-series-get-started-with-flower-pytorch.ipynb" msgstr "" -"https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-get-started-with-flower-pytorch.ipynb" #: ../../source/contributor-how-to-install-development-versions.rst:63 @@ -908,10 +908,10 @@ msgstr "" #, fuzzy msgid "" "https://colab.research.google.com/github/adap/flower/blob/branch-" -"name/doc/source/tutorial-series-get-started-with-flower-pytorch.ipynb" +"name/framework/docs/source/tutorial-series-get-started-with-flower-pytorch.ipynb" msgstr "" "https://colab.research.google.com/github/adap/flower/blob/branch-" -"name/doc/source/tutorial-get-started-with-flower-pytorch.ipynb" +"name/framework/docs/source/tutorial-get-started-with-flower-pytorch.ipynb" #: ../../source/contributor-how-to-install-development-versions.rst:68 msgid "Install a `whl` on Google Colab:" @@ -1301,8 +1301,8 @@ msgid "Edit an existing page" msgstr "Modifier une page existante" #: ../../source/contributor-how-to-write-documentation.rst:17 -msgid "Edit an existing ``.rst`` (or ``.md``) file under ``doc/source/``" -msgstr "Modifier un fichier ``.rst`` (ou ``.md``) existant sous ``doc/source/``" +msgid "Edit an existing ``.rst`` (or ``.md``) file under ``framework/docs/source/``" +msgstr "Modifier un fichier ``.rst`` (ou ``.md``) existant sous ``framework/docs/source/``" #: ../../source/contributor-how-to-write-documentation.rst:18 #: ../../source/contributor-how-to-write-documentation.rst:27 @@ -1311,9 +1311,9 @@ msgstr "Compilez les documents : ``cd doc``, puis ``poetry run make html``" #: ../../source/contributor-how-to-write-documentation.rst:19 #: ../../source/contributor-how-to-write-documentation.rst:28 -msgid "Open ``doc/build/html/index.html`` in the browser to check the result" +msgid "Open ``framework/docs/build/html/index.html`` in the browser to check the result" msgstr "" -"Ouvre ``doc/build/html/index.html`` dans le navigateur pour vérifier le " +"Ouvre ``framework/docs/build/html/index.html`` dans le navigateur pour vérifier le " "résultat" #: ../../source/contributor-how-to-write-documentation.rst:22 @@ -1321,8 +1321,8 @@ msgid "Create a new page" msgstr "Créer une nouvelle page" #: ../../source/contributor-how-to-write-documentation.rst:24 -msgid "Add new ``.rst`` file under ``doc/source/``" -msgstr "Ajouter un nouveau fichier ``.rst`` sous ``doc/source/``" +msgid "Add new ``.rst`` file under ``framework/docs/source/``" +msgstr "Ajouter un nouveau fichier ``.rst`` sous ``framework/docs/source/``" #: ../../source/contributor-how-to-write-documentation.rst:25 msgid "Add content to the new ``.rst`` file" @@ -2129,8 +2129,8 @@ msgstr "" #: ../../source/contributor-tutorial-contribute-on-github.rst:307 #, fuzzy -msgid "Find the source file in ``doc/source``" -msgstr "Trouve le fichier source dans `doc/source`" +msgid "Find the source file in ``framework/docs/source``" +msgstr "Trouve le fichier source dans `framework/docs/source`" #: ../../source/contributor-tutorial-contribute-on-github.rst:308 #, fuzzy @@ -2179,8 +2179,8 @@ msgstr "Change le nom du fichier en `save-progress.rst`" #: ../../source/contributor-tutorial-contribute-on-github.rst:323 #, fuzzy -msgid "Add a redirect rule to ``doc/source/conf.py``" -msgstr "Ajouter une règle de redirection à `doc/source/conf.py`" +msgid "Add a redirect rule to ``framework/docs/source/conf.py``" +msgstr "Ajouter une règle de redirection à `framework/docs/source/conf.py`" #: ../../source/contributor-tutorial-contribute-on-github.rst:325 #, fuzzy @@ -2622,7 +2622,7 @@ msgid "" msgstr "" #: ../../source/contributor-tutorial-get-started-as-a-contributor.rst:194 -msgid "This will generate HTML documentation in ``doc/build/html``." +msgid "This will generate HTML documentation in ``framework/docs/build/html``." msgstr "" #: ../../source/docker/enable-tls.rst:2 @@ -22279,13 +22279,13 @@ msgstr "" msgid "" "The Flower tutorial now has a new section that covers implementing a " "custom strategy from scratch: [Open in " -"Colab](https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"Colab](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-build-a-strategy-from-scratch-pytorch.ipynb)" msgstr "" "Le tutoriel sur les fleurs comporte désormais une nouvelle section qui " "traite de la mise en œuvre d'une stratégie personnalisée à partir de zéro" " : [Ouvrir dans " -"Colab](https://colab.research.google.com/github/adap/flower/blob/main/doc/source/tutorial/Flower-3-Building-a" +"Colab](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source/tutorial/Flower-3-Building-a" "-Strategy-PyTorch.ipynb)" #: ../../source/ref-changelog.md:987 @@ -22301,12 +22301,12 @@ msgstr "" msgid "" "The Flower tutorial now has a new section that covers custom " "serialization: [Open in " -"Colab](https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"Colab](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-customize-the-client-pytorch.ipynb)" msgstr "" "Le tutoriel sur les fleurs comporte désormais une nouvelle section qui " "traite de la sérialisation personnalisée : [Ouvrir dans " -"Colab](https://colab.research.google.com/github/adap/flower/blob/main/doc/source/tutorial/Flower-4" +"Colab](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source/tutorial/Flower-4" "-Client-and-NumPyClient-PyTorch.ipynb)" #: ../../source/ref-changelog.md:991 diff --git a/framework/docs/locales/ko/LC_MESSAGES/framework-docs.po b/framework/docs/locales/ko/LC_MESSAGES/framework-docs.po index 577ee112f1ca..c5241c94358f 100644 --- a/framework/docs/locales/ko/LC_MESSAGES/framework-docs.po +++ b/framework/docs/locales/ko/LC_MESSAGES/framework-docs.po @@ -878,18 +878,18 @@ msgstr "Google Colab에서 Jupyter Notebooks 열기" #: ../../source/contributor-how-to-install-development-versions.rst:59 msgid "" -"Open the notebook ``doc/source/tutorial-series-get-started-with-flower-" +"Open the notebook ``framework/docs/source/tutorial-series-get-started-with-flower-" "pytorch.ipynb``:" msgstr "" -"``doc/source/tutorial-series-get-started-with-flower-" +"``framework/docs/source/tutorial-series-get-started-with-flower-" "pytorch.ipynb``notebook을 엽니다:" #: ../../source/contributor-how-to-install-development-versions.rst:61 msgid "" -"https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-series-get-started-with-flower-pytorch.ipynb" msgstr "" -"https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-series-get-started-with-flower-pytorch.ipynb" #: ../../source/contributor-how-to-install-development-versions.rst:63 @@ -903,10 +903,10 @@ msgstr "" #: ../../source/contributor-how-to-install-development-versions.rst:66 msgid "" "https://colab.research.google.com/github/adap/flower/blob/branch-" -"name/doc/source/tutorial-series-get-started-with-flower-pytorch.ipynb" +"name/framework/docs/source/tutorial-series-get-started-with-flower-pytorch.ipynb" msgstr "" "https://colab.research.google.com/github/adap/flower/blob/branch-" -"name/doc/source/tutorial-series-get-started-with-flower-pytorch.ipynb" +"name/framework/docs/source/tutorial-series-get-started-with-flower-pytorch.ipynb" #: ../../source/contributor-how-to-install-development-versions.rst:68 msgid "Install a `whl` on Google Colab:" @@ -1278,8 +1278,8 @@ msgid "Edit an existing page" msgstr "기존 페이지 편집" #: ../../source/contributor-how-to-write-documentation.rst:17 -msgid "Edit an existing ``.rst`` (or ``.md``) file under ``doc/source/``" -msgstr "doc/source/``에서 기존 ``.rst``(또는 ``.md``) 파일을 편집합니다" +msgid "Edit an existing ``.rst`` (or ``.md``) file under ``framework/docs/source/``" +msgstr "framework/docs/source/``에서 기존 ``.rst``(또는 ``.md``) 파일을 편집합니다" #: ../../source/contributor-how-to-write-documentation.rst:18 #: ../../source/contributor-how-to-write-documentation.rst:27 @@ -1296,8 +1296,8 @@ msgid "Create a new page" msgstr "새 페이지 만들기" #: ../../source/contributor-how-to-write-documentation.rst:24 -msgid "Add new ``.rst`` file under ``doc/source/``" -msgstr "``doc/source/`에 새 ``.rst`` 을 추가합니다" +msgid "Add new ``.rst`` file under ``framework/docs/source/``" +msgstr "``framework/docs/source/`에 새 ``.rst`` 을 추가합니다" #: ../../source/contributor-how-to-write-documentation.rst:25 msgid "Add content to the new ``.rst`` file" @@ -1978,8 +1978,8 @@ msgstr "" "같이 하세요:" #: ../../source/contributor-tutorial-contribute-on-github.rst:307 -msgid "Find the source file in ``doc/source``" -msgstr "``doc/source``에서 소스 파일을 찾습니다" +msgid "Find the source file in ``framework/docs/source``" +msgstr "``framework/docs/source``에서 소스 파일을 찾습니다" #: ../../source/contributor-tutorial-contribute-on-github.rst:308 msgid "" @@ -2018,8 +2018,8 @@ msgid "Change the file name to ``save-progress.rst``" msgstr "파일 이름을 ``save-progress.rst``로 변경합니다" #: ../../source/contributor-tutorial-contribute-on-github.rst:323 -msgid "Add a redirect rule to ``doc/source/conf.py``" -msgstr "'doc/source/conf.py'에 리디렉션 규칙을 추가합니다" +msgid "Add a redirect rule to ``framework/docs/source/conf.py``" +msgstr "'framework/docs/source/conf.py'에 리디렉션 규칙을 추가합니다" #: ../../source/contributor-tutorial-contribute-on-github.rst:325 msgid "" @@ -21190,7 +21190,7 @@ msgstr "" msgid "" "The Flower tutorial now has a new section that covers implementing a " "custom strategy from scratch: [Open in " -"Colab](https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"Colab](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-build-a-strategy-from-scratch-pytorch.ipynb)" msgstr "" @@ -21204,7 +21204,7 @@ msgstr "" msgid "" "The Flower tutorial now has a new section that covers custom " "serialization: [Open in " -"Colab](https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"Colab](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-customize-the-client-pytorch.ipynb)" msgstr "" diff --git a/framework/docs/locales/pt_BR/LC_MESSAGES/framework-docs.po b/framework/docs/locales/pt_BR/LC_MESSAGES/framework-docs.po index 20a43baa893d..d7dfaffad02d 100644 --- a/framework/docs/locales/pt_BR/LC_MESSAGES/framework-docs.po +++ b/framework/docs/locales/pt_BR/LC_MESSAGES/framework-docs.po @@ -883,13 +883,13 @@ msgstr "" #: ../../source/contributor-how-to-install-development-versions.rst:59 msgid "" -"Open the notebook ``doc/source/tutorial-series-get-started-with-flower-" +"Open the notebook ``framework/docs/source/tutorial-series-get-started-with-flower-" "pytorch.ipynb``:" msgstr "" #: ../../source/contributor-how-to-install-development-versions.rst:61 msgid "" -"https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-series-get-started-with-flower-pytorch.ipynb" msgstr "" @@ -902,7 +902,7 @@ msgstr "" #: ../../source/contributor-how-to-install-development-versions.rst:66 msgid "" "https://colab.research.google.com/github/adap/flower/blob/branch-" -"name/doc/source/tutorial-series-get-started-with-flower-pytorch.ipynb" +"name/framework/docs/source/tutorial-series-get-started-with-flower-pytorch.ipynb" msgstr "" #: ../../source/contributor-how-to-install-development-versions.rst:68 @@ -1227,7 +1227,7 @@ msgid "Edit an existing page" msgstr "" #: ../../source/contributor-how-to-write-documentation.rst:17 -msgid "Edit an existing ``.rst`` (or ``.md``) file under ``doc/source/``" +msgid "Edit an existing ``.rst`` (or ``.md``) file under ``framework/docs/source/``" msgstr "" #: ../../source/contributor-how-to-write-documentation.rst:18 @@ -1245,7 +1245,7 @@ msgid "Create a new page" msgstr "" #: ../../source/contributor-how-to-write-documentation.rst:24 -msgid "Add new ``.rst`` file under ``doc/source/``" +msgid "Add new ``.rst`` file under ``framework/docs/source/``" msgstr "" #: ../../source/contributor-how-to-write-documentation.rst:25 @@ -1859,7 +1859,7 @@ msgid "" msgstr "" #: ../../source/contributor-tutorial-contribute-on-github.rst:307 -msgid "Find the source file in ``doc/source``" +msgid "Find the source file in ``framework/docs/source``" msgstr "" #: ../../source/contributor-tutorial-contribute-on-github.rst:308 @@ -1895,7 +1895,7 @@ msgid "Change the file name to ``save-progress.rst``" msgstr "" #: ../../source/contributor-tutorial-contribute-on-github.rst:323 -msgid "Add a redirect rule to ``doc/source/conf.py``" +msgid "Add a redirect rule to ``framework/docs/source/conf.py``" msgstr "" #: ../../source/contributor-tutorial-contribute-on-github.rst:325 @@ -19885,7 +19885,7 @@ msgstr "" msgid "" "The Flower tutorial now has a new section that covers implementing a " "custom strategy from scratch: [Open in " -"Colab](https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"Colab](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-build-a-strategy-from-scratch-pytorch.ipynb)" msgstr "" @@ -19899,7 +19899,7 @@ msgstr "" msgid "" "The Flower tutorial now has a new section that covers custom " "serialization: [Open in " -"Colab](https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"Colab](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-customize-the-client-pytorch.ipynb)" msgstr "" @@ -25765,7 +25765,7 @@ msgstr "" #~ "something similar to this:" #~ msgstr "" -#~ msgid "Find the source file in `doc/source`" +#~ msgid "Find the source file in `framework/docs/source`" #~ msgstr "" #~ msgid "" @@ -25778,7 +25778,7 @@ msgstr "" #~ msgid "Change the file name to `save-progress.rst`" #~ msgstr "" -#~ msgid "Add a redirect rule to `doc/source/conf.py`" +#~ msgid "Add a redirect rule to `framework/docs/source/conf.py`" #~ msgstr "" #~ msgid "" @@ -27615,19 +27615,19 @@ msgstr "" #~ msgstr "A tag da imagem da imagem base." #~ msgid "" -#~ "Open the notebook ``doc/source/tutorial-" +#~ "Open the notebook ``framework/docs/source/tutorial-" #~ "get-started-with-flower-pytorch.ipynb``:" #~ msgstr "" #~ msgid "" -#~ "https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +#~ "https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" #~ "/tutorial-get-started-with-flower-" #~ "pytorch.ipynb" #~ msgstr "" #~ msgid "" #~ "https://colab.research.google.com/github/adap/flower/blob/branch-" -#~ "name/doc/source/tutorial-get-started-with-" +#~ "name/framework/docs/source/tutorial-get-started-with-" #~ "flower-pytorch.ipynb" #~ msgstr "" diff --git a/framework/docs/locales/zh_Hans/LC_MESSAGES/framework-docs.po b/framework/docs/locales/zh_Hans/LC_MESSAGES/framework-docs.po index 05ad09a99575..cdc4a3d6c119 100644 --- a/framework/docs/locales/zh_Hans/LC_MESSAGES/framework-docs.po +++ b/framework/docs/locales/zh_Hans/LC_MESSAGES/framework-docs.po @@ -891,17 +891,17 @@ msgstr "在谷歌 Colab 上打开 Jupyter 笔记本" #: ../../source/contributor-how-to-install-development-versions.rst:59 #, fuzzy msgid "" -"Open the notebook ``doc/source/tutorial-series-get-started-with-flower-" +"Open the notebook ``framework/docs/source/tutorial-series-get-started-with-flower-" "pytorch.ipynb``:" -msgstr "打开笔记本 ``doc/source/tutorial-get-started-with-flower-pytorch.ipynb``：" +msgstr "打开笔记本 ``framework/docs/source/tutorial-get-started-with-flower-pytorch.ipynb``：" #: ../../source/contributor-how-to-install-development-versions.rst:61 #, fuzzy msgid "" -"https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-series-get-started-with-flower-pytorch.ipynb" msgstr "" -"https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-get-started-with-flower-pytorch.ipynb" #: ../../source/contributor-how-to-install-development-versions.rst:63 @@ -916,10 +916,10 @@ msgstr "" #, fuzzy msgid "" "https://colab.research.google.com/github/adap/flower/blob/branch-" -"name/doc/source/tutorial-series-get-started-with-flower-pytorch.ipynb" +"name/framework/docs/source/tutorial-series-get-started-with-flower-pytorch.ipynb" msgstr "" "https://colab.research.google.com/github/adap/flower/blob/branch-" -"name/doc/source/tutorial-get-started-with-flower-pytorch.ipynb" +"name/framework/docs/source/tutorial-get-started-with-flower-pytorch.ipynb" #: ../../source/contributor-how-to-install-development-versions.rst:68 msgid "Install a `whl` on Google Colab:" @@ -1287,8 +1287,8 @@ msgid "Edit an existing page" msgstr "编辑现有页面" #: ../../source/contributor-how-to-write-documentation.rst:17 -msgid "Edit an existing ``.rst`` (or ``.md``) file under ``doc/source/``" -msgstr "编辑 ``doc/source/`` 下现有的 ``.rst`` (或 ``.md``) 文件" +msgid "Edit an existing ``.rst`` (or ``.md``) file under ``framework/docs/source/``" +msgstr "编辑 ``framework/docs/source/`` 下现有的 ``.rst`` (或 ``.md``) 文件" #: ../../source/contributor-how-to-write-documentation.rst:18 #: ../../source/contributor-how-to-write-documentation.rst:27 @@ -1305,8 +1305,8 @@ msgid "Create a new page" msgstr "创建新页面" #: ../../source/contributor-how-to-write-documentation.rst:24 -msgid "Add new ``.rst`` file under ``doc/source/``" -msgstr "在 ``doc/source/`` 下添加新的 ``.rst`` 文件" +msgid "Add new ``.rst`` file under ``framework/docs/source/``" +msgstr "在 ``framework/docs/source/`` 下添加新的 ``.rst`` 文件" #: ../../source/contributor-how-to-write-documentation.rst:25 msgid "Add content to the new ``.rst`` file" @@ -1973,8 +1973,8 @@ msgstr "这只是一个很小的改动，但可以让我们测试你的端到端 #: ../../source/contributor-tutorial-contribute-on-github.rst:307 #, fuzzy -msgid "Find the source file in ``doc/source``" -msgstr "在 `doc/source` 中查找源文件" +msgid "Find the source file in ``framework/docs/source``" +msgstr "在 `framework/docs/source` 中查找源文件" #: ../../source/contributor-tutorial-contribute-on-github.rst:308 #, fuzzy @@ -2018,8 +2018,8 @@ msgstr "将文件名改为`save-progress.rst`" #: ../../source/contributor-tutorial-contribute-on-github.rst:323 #, fuzzy -msgid "Add a redirect rule to ``doc/source/conf.py``" -msgstr "在 `doc/source/conf.py` 中添加重定向规则" +msgid "Add a redirect rule to ``framework/docs/source/conf.py``" +msgstr "在 `framework/docs/source/conf.py` 中添加重定向规则" #: ../../source/contributor-tutorial-contribute-on-github.rst:325 #, fuzzy @@ -24000,11 +24000,11 @@ msgstr "**添加新的自定义策略教程部分** [#1623](https://github.com/a msgid "" "The Flower tutorial now has a new section that covers implementing a " "custom strategy from scratch: [Open in " -"Colab](https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"Colab](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-build-a-strategy-from-scratch-pytorch.ipynb)" msgstr "" "Flower 教程新增了一个章节，介绍如何从零开始实施自定义策略： [在 Colab " -"中打开](https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"中打开](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-build-a-strategy-from-scratch-pytorch.ipynb)" #: ../../source/ref-changelog.md:987 @@ -24017,11 +24017,11 @@ msgstr "** 添加新的自定义序列化教程部分** ([#1622](https://github. msgid "" "The Flower tutorial now has a new section that covers custom " "serialization: [Open in " -"Colab](https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"Colab](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-customize-the-client-pytorch.ipynb)" msgstr "" "Flower 教程现在新增了一个章节，介绍自定义序列化： [在 Colab " -"中打开](https://colab.research.google.com/github/adap/flower/blob/main/doc/source" +"中打开](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source" "/tutorial-customize-the-client-pytorch.ipynb)" #: ../../source/ref-changelog.md:991 diff --git a/framework/docs/source/conf.py b/framework/docs/source/conf.py index 6b4e30e17d16..96720ed483c5 100644 --- a/framework/docs/source/conf.py +++ b/framework/docs/source/conf.py @@ -296,7 +296,7 @@ def find_test_modules(package_path): # https://sphinx-book-theme.readthedocs.io/en/latest/configure.html # "repository_url": "https://github.com/adap/flower", # "repository_branch": "main", - # "path_to_docs": "doc/source/", + # "path_to_docs": "framework/docs/source/", # "home_page_in_toc": True, # "use_repository_button": True, # "use_issues_button": True, @@ -338,7 +338,7 @@ def find_test_modules(package_path): .. raw:: html
- + Open in Colab """ diff --git a/framework/docs/source/contributor-how-to-install-development-versions.rst b/framework/docs/source/contributor-how-to-install-development-versions.rst index 61c123a24309..5288eb832d52 100644 --- a/framework/docs/source/contributor-how-to-install-development-versions.rst +++ b/framework/docs/source/contributor-how-to-install-development-versions.rst @@ -56,14 +56,15 @@ Install ``flwr`` from a specific GitHub branch (``branch-name``): Open Jupyter Notebooks on Google Colab -------------------------------------- -Open the notebook ``doc/source/tutorial-series-get-started-with-flower-pytorch.ipynb``: +Open the notebook +``framework/docs/source/tutorial-series-get-started-with-flower-pytorch.ipynb``: -- https://colab.research.google.com/github/adap/flower/blob/main/doc/source/tutorial-series-get-started-with-flower-pytorch.ipynb +- https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source/tutorial-series-get-started-with-flower-pytorch.ipynb Open a development version of the same notebook from branch `branch-name` by changing ``main`` to ``branch-name`` (right after ``blob``): -- https://colab.research.google.com/github/adap/flower/blob/branch-name/doc/source/tutorial-series-get-started-with-flower-pytorch.ipynb +- https://colab.research.google.com/github/adap/flower/blob/branch-name/framework/docs/source/tutorial-series-get-started-with-flower-pytorch.ipynb Install a `whl` on Google Colab: diff --git a/framework/docs/source/contributor-how-to-write-documentation.rst b/framework/docs/source/contributor-how-to-write-documentation.rst index 6209530b71e0..a0ea3f9613a5 100644 --- a/framework/docs/source/contributor-how-to-write-documentation.rst +++ b/framework/docs/source/contributor-how-to-write-documentation.rst @@ -14,15 +14,15 @@ installed on the system. Edit an existing page --------------------- -1. Edit an existing ``.rst`` (or ``.md``) file under ``doc/source/`` -2. Compile the docs: ``cd doc``, then ``poetry run make html`` -3. Open ``doc/build/html/index.html`` in the browser to check the result +1. Edit an existing ``.rst`` (or ``.md``) file under ``framework/docs/source/`` +2. Compile the docs: ``cd framework/docs``, then ``poetry run make html`` +3. Open ``framework/docs/build/html/index.html`` in the browser to check the result Create a new page ----------------- -1. Add new ``.rst`` file under ``doc/source/`` +1. Add new ``.rst`` file under ``framework/docs/source/`` 2. Add content to the new ``.rst`` file 3. Link to the new rst from ``index.rst`` -4. Compile the docs: ``cd doc``, then ``poetry run make html`` -5. Open ``doc/build/html/index.html`` in the browser to check the result +4. Compile the docs: ``cd framework/docs``, then ``poetry run make html`` +5. Open ``framework/docs/build/html/index.html`` in the browser to check the result diff --git a/framework/docs/source/contributor-tutorial-contribute-on-github.rst b/framework/docs/source/contributor-tutorial-contribute-on-github.rst index 22c6c6ef86b0..675465a6437f 100644 --- a/framework/docs/source/contributor-tutorial-contribute-on-github.rst +++ b/framework/docs/source/contributor-tutorial-contribute-on-github.rst @@ -304,7 +304,7 @@ Solution This is a tiny change, but it'll allow us to test your end-to-end setup. After cloning and setting up the Flower repo, here's what you should do: -- Find the source file in ``doc/source`` +- Find the source file in ``framework/docs/source`` - Make the change in the ``.rst`` file (beware, the dashes under the title should be the same length as the title itself) - Build the docs and `check the result @@ -320,7 +320,7 @@ avoid that, breaking links can harm our search engine ranking. Here's how to change the file name: - Change the file name to ``save-progress.rst`` -- Add a redirect rule to ``doc/source/conf.py`` +- Add a redirect rule to ``framework/docs/source/conf.py`` This will cause a redirect from ``saving-progress.html`` to ``save-progress.html``, old links will continue to work. diff --git a/framework/docs/source/ref-changelog.md b/framework/docs/source/ref-changelog.md index b2e82b3d774c..e290f0e3ef55 100644 --- a/framework/docs/source/ref-changelog.md +++ b/framework/docs/source/ref-changelog.md @@ -1053,11 +1053,11 @@ We would like to give our special thanks to all the contributors who made the ne - **Add new custom strategy tutorial section** [#1623](https://github.com/adap/flower/pull/1623) - The Flower tutorial now has a new section that covers implementing a custom strategy from scratch: [Open in Colab](https://colab.research.google.com/github/adap/flower/blob/main/doc/source/tutorial-build-a-strategy-from-scratch-pytorch.ipynb) + The Flower tutorial now has a new section that covers implementing a custom strategy from scratch: [Open in Colab](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source/tutorial-build-a-strategy-from-scratch-pytorch.ipynb) - **Add new custom serialization tutorial section** ([#1622](https://github.com/adap/flower/pull/1622)) - The Flower tutorial now has a new section that covers custom serialization: [Open in Colab](https://colab.research.google.com/github/adap/flower/blob/main/doc/source/tutorial-customize-the-client-pytorch.ipynb) + The Flower tutorial now has a new section that covers custom serialization: [Open in Colab](https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source/tutorial-customize-the-client-pytorch.ipynb) - **General improvements** ([#1638](https://github.com/adap/flower/pull/1638), [#1634](https://github.com/adap/flower/pull/1634), [#1636](https://github.com/adap/flower/pull/1636), [#1635](https://github.com/adap/flower/pull/1635), [#1633](https://github.com/adap/flower/pull/1633), [#1632](https://github.com/adap/flower/pull/1632), [#1631](https://github.com/adap/flower/pull/1631), [#1630](https://github.com/adap/flower/pull/1630), [#1627](https://github.com/adap/flower/pull/1627), [#1593](https://github.com/adap/flower/pull/1593), [#1616](https://github.com/adap/flower/pull/1616), [#1615](https://github.com/adap/flower/pull/1615), [#1607](https://github.com/adap/flower/pull/1607), [#1609](https://github.com/adap/flower/pull/1609), [#1608](https://github.com/adap/flower/pull/1608), [#1603](https://github.com/adap/flower/pull/1603), [#1590](https://github.com/adap/flower/pull/1590), [#1580](https://github.com/adap/flower/pull/1580), [#1599](https://github.com/adap/flower/pull/1599), [#1600](https://github.com/adap/flower/pull/1600), [#1601](https://github.com/adap/flower/pull/1601), [#1597](https://github.com/adap/flower/pull/1597), [#1595](https://github.com/adap/flower/pull/1595), [#1591](https://github.com/adap/flower/pull/1591), [#1588](https://github.com/adap/flower/pull/1588), [#1589](https://github.com/adap/flower/pull/1589), [#1587](https://github.com/adap/flower/pull/1587), [#1573](https://github.com/adap/flower/pull/1573), [#1581](https://github.com/adap/flower/pull/1581), [#1578](https://github.com/adap/flower/pull/1578), [#1574](https://github.com/adap/flower/pull/1574), [#1572](https://github.com/adap/flower/pull/1572), [#1586](https://github.com/adap/flower/pull/1586))