docs(*:skip) Update links to new path (#4754)

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`

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**.
 

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

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

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*"

examples/docs/source/conf.py

@@ -121,7 +121,7 @@
 .. raw:: html
 
     <br/>
-    <a href="https://colab.research.google.com/github/adap/flower/blob/main/doc/source/{{ env.doc2path(env.docname, base=None) }}">
+    <a href="https://colab.research.google.com/github/adap/flower/blob/main/framework/docs/source/{{ env.doc2path(env.docname, base=None) }}">
         <img alt="Open in Colab" src="https://colab.research.google.com/assets/colab-badge.svg"/>
     </a>
 """

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,18 +1311,18 @@ 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
 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

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 ""