refactor(*:skip) Move docs from doc to docs (#4660)

Co-authored-by: Daniel J. Beutel <[email protected]> Co-authored-by: Taner Topal <[email protected]>
adap · Dec 11, 2024 · 85b5855 · 85b5855
1 parent d67c38f
commit 85b5855
Show file tree

Hide file tree

Showing 59 changed files with 32 additions and 26 deletions.
diff --git a/.github/workflows/baselines.yml b/.github/workflows/baselines.yml
@@ -36,7 +36,7 @@ jobs:
                 FILTER+=$(echo "$DIR: ${BASELINES_PATH}/**\n")
             done < <(find baselines -maxdepth 1 \
                 -name ".*" -prune -o \
-                -path "baselines/doc" -prune -o \
+                -path "baselines/docs" -prune -o \
                 -path "baselines/dev" -prune -o \
                 -path "baselines/baseline_template" -prune -o \
                 -path "baselines/flwr_baselines" -prune -o \

diff --git a/baselines/doc/Makefile → baselines/docs/Makefile b/baselines/doc/Makefile → baselines/docs/Makefile
diff --git a/baselines/doc/make.bat → baselines/docs/make.bat b/baselines/doc/make.bat → baselines/docs/make.bat
diff --git a/baselines/doc/source/.gitignore → baselines/docs/source/.gitignore b/baselines/doc/source/.gitignore → baselines/docs/source/.gitignore
diff --git a/baselines/doc/source/_static/custom.css → baselines/docs/source/_static/custom.css b/baselines/doc/source/_static/custom.css → baselines/docs/source/_static/custom.css
diff --git a/baselines/doc/source/_static/favicon.ico → baselines/docs/source/_static/favicon.ico b/baselines/doc/source/_static/favicon.ico → baselines/docs/source/_static/favicon.ico
diff --git a/baselines/doc/source/_static/flower-logo.png → ...lines/docs/source/_static/flower-logo.png b/baselines/doc/source/_static/flower-logo.png → ...lines/docs/source/_static/flower-logo.png
diff --git a/baselines/doc/source/_static/view-gh.png → baselines/docs/source/_static/view-gh.png b/baselines/doc/source/_static/view-gh.png → baselines/docs/source/_static/view-gh.png
diff --git a/baselines/doc/source/_templates/base.html → baselines/docs/source/_templates/base.html b/baselines/doc/source/_templates/base.html → baselines/docs/source/_templates/base.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/baselines/doc/source/conf.py → baselines/docs/source/conf.py b/baselines/doc/source/conf.py → baselines/docs/source/conf.py
@@ -12,12 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ==============================================================================
+"""Config for Sphinx docs."""
 
 
 import datetime
 import os
 import sys
-from sphinx.application import ConfigError
+
 
 # Configuration file for the Sphinx documentation builder.
 #
@@ -120,11 +121,15 @@
 
 nbsphinx_execute = "never"
 
-_open_in_colab_button = """
+colab_link = (
+    "https://colab.research.google.com/github/adap/flower/blob/main/"
+    "doc/source/{{ env.doc2path(env.docname, base=None) }}"
+)
+_open_in_colab_button = f"""
 .. 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="{colab_link}">
         <img alt="Open in Colab" src="https://colab.research.google.com/assets/colab-badge.svg"/>
     </a>
 """

diff --git a/...oc/source/how-to-contribute-baselines.rst → ...cs/source/how-to-contribute-baselines.rst b/...oc/source/how-to-contribute-baselines.rst → ...cs/source/how-to-contribute-baselines.rst
diff --git a/...lines/doc/source/how-to-use-baselines.rst → ...ines/docs/source/how-to-use-baselines.rst b/...lines/doc/source/how-to-use-baselines.rst → ...ines/docs/source/how-to-use-baselines.rst
diff --git a/baselines/doc/source/index.rst → baselines/docs/source/index.rst b/baselines/doc/source/index.rst → baselines/docs/source/index.rst
diff --git a/datasets/dev/build-flwr-datasets-docs.sh b/datasets/dev/build-flwr-datasets-docs.sh
@@ -22,7 +22,7 @@
 
 set -e
 
-cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )"  >/dev/null 2>&1 && pwd )"/../doc
+cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )"  >/dev/null 2>&1 && pwd )"/../docs
 
 # Remove the old docs from source/ref-api
 REF_API_DIR="source/ref-api"

diff --git a/datasets/doc/Makefile → datasets/docs/Makefile b/datasets/doc/Makefile → datasets/docs/Makefile
diff --git a/datasets/doc/make.bat → datasets/docs/make.bat b/datasets/doc/make.bat → datasets/docs/make.bat
diff --git a/datasets/doc/source/.gitignore → datasets/docs/source/.gitignore b/datasets/doc/source/.gitignore → datasets/docs/source/.gitignore
diff --git a/datasets/doc/source/_static/custom.css → datasets/docs/source/_static/custom.css b/datasets/doc/source/_static/custom.css → datasets/docs/source/_static/custom.css
diff --git a/datasets/doc/source/_static/favicon.ico → datasets/docs/source/_static/favicon.ico b/datasets/doc/source/_static/favicon.ico → datasets/docs/source/_static/favicon.ico
diff --git a/...c/source/_static/flower-datasets-logo.png → ...s/source/_static/flower-datasets-logo.png b/...c/source/_static/flower-datasets-logo.png → ...s/source/_static/flower-datasets-logo.png
diff --git a/...me/comparison_of_partitioning_schemes.png → ...me/comparison_of_partitioning_schemes.png b/...me/comparison_of_partitioning_schemes.png → ...me/comparison_of_partitioning_schemes.png
diff --git a/...tutorial-quickstart/choose-hf-dataset.png → ...tutorial-quickstart/choose-hf-dataset.png b/...tutorial-quickstart/choose-hf-dataset.png → ...tutorial-quickstart/choose-hf-dataset.png
diff --git a/...tutorial-quickstart/copy-dataset-name.png → ...tutorial-quickstart/copy-dataset-name.png b/...tutorial-quickstart/copy-dataset-name.png → ...tutorial-quickstart/copy-dataset-name.png
diff --git a/...al-quickstart/partitioner-flexibility.png → ...al-quickstart/partitioner-flexibility.png b/...al-quickstart/partitioner-flexibility.png → ...al-quickstart/partitioner-flexibility.png
diff --git a/...oc/source/_templates/autosummary/base.rst → ...cs/source/_templates/autosummary/base.rst b/...oc/source/_templates/autosummary/base.rst → ...cs/source/_templates/autosummary/base.rst
diff --git a/...c/source/_templates/autosummary/class.rst → ...s/source/_templates/autosummary/class.rst b/...c/source/_templates/autosummary/class.rst → ...s/source/_templates/autosummary/class.rst
diff --git a/.../source/_templates/autosummary/module.rst → .../source/_templates/autosummary/module.rst b/.../source/_templates/autosummary/module.rst → .../source/_templates/autosummary/module.rst
diff --git a/datasets/doc/source/_templates/base.html → datasets/docs/source/_templates/base.html b/datasets/doc/source/_templates/base.html → datasets/docs/source/_templates/base.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/datasets/doc/source/conf.py → datasets/docs/source/conf.py b/datasets/doc/source/conf.py → datasets/docs/source/conf.py
@@ -17,6 +17,7 @@
 import datetime
 import os
 import sys
+
 from sphinx.application import ConfigError
 
 # Configuration file for the Sphinx documentation builder.
@@ -162,7 +163,7 @@ def find_test_modules(package_path):
 .. raw:: html
 
     <br/>
-    <a href="https://colab.research.google.com/github/adap/flower/blob/main/datasets/doc/source/{{ env.doc2path(env.docname, base=None) }}">
+    <a href="https://colab.research.google.com/github/adap/flower/blob/main/datasets/docs/source/{{ env.doc2path(env.docname, base=None) }}">
         <img alt="Open in Colab" src="https://colab.research.google.com/assets/colab-badge.svg"/>
     </a>
 """
@@ -182,5 +183,5 @@ def find_test_modules(package_path):
 myst_heading_anchors = 3
 
 # -- Options for sphinx_copybutton -------------------------------------
-copybutton_exclude = '.linenos, .gp, .go'
+copybutton_exclude = ".linenos, .gp, .go"
 copybutton_prompt_text = ">>> "
diff --git a/...contributor-how-to-contribute-dataset.rst → ...contributor-how-to-contribute-dataset.rst b/...contributor-how-to-contribute-dataset.rst → ...contributor-how-to-contribute-dataset.rst
diff --git a/...ce/how-to-disable-enable-progress-bar.rst → ...ce/how-to-disable-enable-progress-bar.rst b/...ce/how-to-disable-enable-progress-bar.rst → ...ce/how-to-disable-enable-progress-bar.rst
diff --git a/...c/source/how-to-install-flwr-datasets.rst → ...s/source/how-to-install-flwr-datasets.rst b/...c/source/how-to-install-flwr-datasets.rst → ...s/source/how-to-install-flwr-datasets.rst
diff --git a/...doc/source/how-to-use-with-local-data.rst → ...ocs/source/how-to-use-with-local-data.rst b/...doc/source/how-to-use-with-local-data.rst → ...ocs/source/how-to-use-with-local-data.rst
diff --git a/...sets/doc/source/how-to-use-with-numpy.rst → ...ets/docs/source/how-to-use-with-numpy.rst b/...sets/doc/source/how-to-use-with-numpy.rst → ...ets/docs/source/how-to-use-with-numpy.rst
diff --git a/...ts/doc/source/how-to-use-with-pytorch.rst → ...s/docs/source/how-to-use-with-pytorch.rst b/...ts/doc/source/how-to-use-with-pytorch.rst → ...s/docs/source/how-to-use-with-pytorch.rst
diff --git a/...doc/source/how-to-use-with-tensorflow.rst → ...ocs/source/how-to-use-with-tensorflow.rst b/...doc/source/how-to-use-with-tensorflow.rst → ...ocs/source/how-to-use-with-tensorflow.rst
diff --git a/datasets/doc/source/index.rst → datasets/docs/source/index.rst b/datasets/doc/source/index.rst → datasets/docs/source/index.rst
diff --git a/...source/recommended-fl-datasets-tables.rst → ...source/recommended-fl-datasets-tables.rst b/...source/recommended-fl-datasets-tables.rst → ...source/recommended-fl-datasets-tables.rst
diff --git a/...ts/doc/source/recommended-fl-datasets.rst → ...s/docs/source/recommended-fl-datasets.rst b/...ts/doc/source/recommended-fl-datasets.rst → ...s/docs/source/recommended-fl-datasets.rst
diff --git a/datasets/doc/source/ref-telemetry.md → datasets/docs/source/ref-telemetry.md b/datasets/doc/source/ref-telemetry.md → datasets/docs/source/ref-telemetry.md
diff --git a/...sets/doc/source/tutorial-quickstart.ipynb → ...ets/docs/source/tutorial-quickstart.ipynb b/...sets/doc/source/tutorial-quickstart.ipynb → ...ets/docs/source/tutorial-quickstart.ipynb
diff --git a/...oc/source/tutorial-use-partitioners.ipynb → ...cs/source/tutorial-use-partitioners.ipynb b/...oc/source/tutorial-use-partitioners.ipynb → ...cs/source/tutorial-use-partitioners.ipynb
diff --git a/...torial-visualize-label-distribution.ipynb → ...torial-visualize-label-distribution.ipynb b/...torial-visualize-label-distribution.ipynb → ...torial-visualize-label-distribution.ipynb
diff --git a/dev/build-baseline-docs.sh b/dev/build-baseline-docs.sh
@@ -3,7 +3,7 @@ set -e
 cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"/../
 
 ROOT=`pwd`
-INDEX=$ROOT/baselines/doc/source/index.rst
+INDEX=$ROOT/baselines/docs/source/index.rst
 
 initial_text=$(cat <<-END
 .. toctree::
@@ -56,7 +56,7 @@ function add_table_entry ()
 
 ! grep -q ":caption: References" $INDEX && echo "$initial_text" >> $INDEX && echo "" >> $INDEX
 
-rm -f "baselines/doc/source/*.md"
+rm -f "baselines/docs/source/*.md"
 
 cd $ROOT/baselines/
 
@@ -67,12 +67,12 @@ for d in $(printf '%s\n' */ | sort -V); do
   # Select directories
   baseline=${d%/}
 
-  if ! [[ "$baseline" =~ ^(baseline_template|dev|doc|flwr_baselines)$ ]]; then
+  if ! [[ "$baseline" =~ ^(baseline_template|dev|docs|flwr_baselines)$ ]]; then
     # For each baseline, copy the README into the source of the Baselines docs
-    cp $baseline/README.md $ROOT/baselines/doc/source/$baseline.md 2>&1 >/dev/null
+    cp $baseline/README.md $ROOT/baselines/docs/source/$baseline.md 2>&1 >/dev/null
 
     gh_text="[<img src=\"_static/view-gh.png\" alt=\"View on GitHub\" width=\"200\"/>](https://github.com/adap/flower/blob/main/baselines/$baseline)"
-    readme_file="$ROOT/baselines/doc/source/$baseline.md"
+    readme_file="$ROOT/baselines/docs/source/$baseline.md"
 
     if ! grep -Fq "$gh_text" "$readme_file"; then
       awk -v text="$gh_text" '
@@ -92,8 +92,8 @@ for d in $(printf '%s\n' */ | sort -V); do
     do
       image_dir=$(dirname $img)
 
-      mkdir -p $ROOT/baselines/doc/source/$image_dir && cp $baseline/$img $_
-      images_arr+=("$ROOT/baselines/doc/source/$img")
+      mkdir -p $ROOT/baselines/docs/source/$image_dir && cp $baseline/$img $_
+      images_arr+=("$ROOT/baselines/docs/source/$img")
     done
 
     if [[ $(grep -L "$baseline" $INDEX) ]]; then
@@ -109,7 +109,7 @@ for d in $(printf '%s\n' */ | sort -V); do
   fi
 done
 
-cd $ROOT/baselines/doc
+cd $ROOT/baselines/docs
 make html
 
 # Restore everything back to the initial state

diff --git a/dev/build-example-docs.py b/dev/build-example-docs.py
@@ -21,7 +21,7 @@
 from pathlib import Path
 
 ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
-INDEX = os.path.join(ROOT, "examples", "doc", "source", "index.rst")
+INDEX = os.path.join(ROOT, "examples", "docs", "source", "index.rst")
 
 initial_text = """
 Flower Examples Documentation
@@ -180,14 +180,14 @@ def _copy_markdown_files(example):
         if file.endswith(".md"):
             src = os.path.join(example, file)
             dest = os.path.join(
-                ROOT, "examples", "doc", "source", os.path.basename(example) + ".md"
+                ROOT, "examples", "docs", "source", os.path.basename(example) + ".md"
             )
             shutil.copyfile(src, dest)
 
 
 def _add_gh_button(example):
     gh_text = f'[<img src="_static/view-gh.png" alt="View on GitHub" width="200"/>](https://github.com/adap/flower/blob/main/examples/{example})'
-    readme_file = os.path.join(ROOT, "examples", "doc", "source", example + ".md")
+    readme_file = os.path.join(ROOT, "examples", "docs", "source", example + ".md")
     with open(readme_file, "r+") as f:
         content = f.read()
         if gh_text not in content:
@@ -201,7 +201,7 @@ def _add_gh_button(example):
 
 def _copy_images(example):
     static_dir = os.path.join(example, "_static")
-    dest_dir = os.path.join(ROOT, "examples", "doc", "source", "_static")
+    dest_dir = os.path.join(ROOT, "examples", "docs", "source", "_static")
     if os.path.isdir(static_dir):
         for file in os.listdir(static_dir):
             if file.endswith((".jpg", ".png", ".jpeg")):
@@ -214,7 +214,7 @@ def _add_all_entries():
     examples_dir = os.path.join(ROOT, "examples")
     for example in sorted(os.listdir(examples_dir)):
         example_path = os.path.join(examples_dir, example)
-        if os.path.isdir(example_path) and example != "doc":
+        if os.path.isdir(example_path) and example != "docs":
             _copy_markdown_files(example_path)
             _add_gh_button(example)
             _copy_images(example)
@@ -230,7 +230,7 @@ def _main():
     examples_dir = os.path.join(ROOT, "examples")
     for example in sorted(os.listdir(examples_dir)):
         example_path = os.path.join(examples_dir, example)
-        if os.path.isdir(example_path) and example != "doc":
+        if os.path.isdir(example_path) and example != "docs":
             _copy_markdown_files(example_path)
             _add_gh_button(example)
             _copy_images(example_path)
@@ -280,4 +280,4 @@ def _main():
 
 if __name__ == "__main__":
     _main()
-    subprocess.call(f"cd {ROOT}/examples/doc && make html", shell=True)
+    subprocess.call(f"cd {ROOT}/examples/docs && make html", shell=True)
diff --git a/dev/update_version.py b/dev/update_version.py
@@ -7,7 +7,7 @@
 
 
 REPLACE_CURR_VERSION = {
-    "doc/source/conf.py": [
+    "framework/docs/source/conf.py": [
         ".. |stable_flwr_version| replace:: {version}",
     ],
     "src/py/flwr/cli/new/templates/app/pyproject.*.toml.tpl": [
@@ -17,11 +17,11 @@
 
 REPLACE_NEXT_VERSION = {
     "pyproject.toml": ['version = "{version}"'],
-    "doc/source/conf.py": [
+    "framework/docs/source/conf.py": [
         'release = "{version}"',
     ],
-    "examples/doc/source/conf.py": ['release = "{version}"'],
-    "baselines/doc/source/conf.py": ['release = "{version}"'],
+    "examples/docs/source/conf.py": ['release = "{version}"'],
+    "baselines/docs/source/conf.py": ['release = "{version}"'],
     "src/docker/complete/compose.yml": ["FLWR_VERSION:-{version}"],
     "src/docker/distributed/client/compose.yml": ["FLWR_VERSION:-{version}"],
     "src/docker/distributed/server/compose.yml": ["FLWR_VERSION:-{version}"],

diff --git a/examples/doc/Makefile → examples/docs/Makefile b/examples/doc/Makefile → examples/docs/Makefile
diff --git a/examples/doc/make.bat → examples/docs/make.bat b/examples/doc/make.bat → examples/docs/make.bat
diff --git a/examples/doc/source/.gitignore → examples/docs/source/.gitignore b/examples/doc/source/.gitignore → examples/docs/source/.gitignore
diff --git a/examples/doc/source/_static/.gitignore → examples/docs/source/_static/.gitignore b/examples/doc/source/_static/.gitignore → examples/docs/source/_static/.gitignore
diff --git a/examples/doc/source/_static/custom.css → examples/docs/source/_static/custom.css b/examples/doc/source/_static/custom.css → examples/docs/source/_static/custom.css
diff --git a/examples/doc/source/_static/favicon.ico → examples/docs/source/_static/favicon.ico b/examples/doc/source/_static/favicon.ico → examples/docs/source/_static/favicon.ico
diff --git a/examples/doc/source/_static/flower-logo.png → examples/docs/source/_static/flower-logo.png b/examples/doc/source/_static/flower-logo.png → examples/docs/source/_static/flower-logo.png
diff --git a/...les/doc/source/_static/tmux_jtop_view.gif → ...es/docs/source/_static/tmux_jtop_view.gif b/...les/doc/source/_static/tmux_jtop_view.gif → ...es/docs/source/_static/tmux_jtop_view.gif
diff --git a/examples/doc/source/_static/view-gh.png → examples/docs/source/_static/view-gh.png b/examples/doc/source/_static/view-gh.png → examples/docs/source/_static/view-gh.png
diff --git a/examples/doc/source/_templates/base.html → examples/docs/source/_templates/base.html b/examples/doc/source/_templates/base.html → examples/docs/source/_templates/base.html
diff --git a/examples/doc/source/conf.py → examples/docs/source/conf.py b/examples/doc/source/conf.py → examples/docs/source/conf.py