From 39348d532ed0a99dc2417df9d5ed2f6a3730201d Mon Sep 17 00:00:00 2001 From: Chong Shen Ng Date: Wed, 22 May 2024 12:23:14 +0100 Subject: [PATCH] docs(framework:skip) Update link for `run-simulation-from-cli` (#3382) --------- Co-authored-by: Daniel J. Beutel --- doc/source/conf.py | 1 + doc/source/how-to-upgrade-to-flower-next.rst | 7 ++++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 1c53a827dcf..feb173c0efa 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -248,6 +248,7 @@ def find_test_modules(package_path): "quickstart-mxnet": "index.html", "tutorial-quickstart-mxnet": "index.html", "example-mxnet-walk-through": "index.html", + "ref-api/flwr.simulation.run_simulation_from_cli.html": "index.html", } # -- Options for HTML output ------------------------------------------------- diff --git a/doc/source/how-to-upgrade-to-flower-next.rst b/doc/source/how-to-upgrade-to-flower-next.rst index 8c8f3c3f8fd..44fad51546b 100644 --- a/doc/source/how-to-upgrade-to-flower-next.rst +++ b/doc/source/how-to-upgrade-to-flower-next.rst @@ -22,21 +22,22 @@ Let's dive in! .. |startclient_link| replace:: ``start_client()`` .. |startserver_link| replace:: ``start_server()`` .. |startsim_link| replace:: ``start_simulation()`` -.. |runsimcli_link| replace:: ``flower-simulation`` .. |runsim_link| replace:: ``run_simulation()`` .. |flowernext_superlink_link| replace:: ``flower-superlink`` .. |flowernext_clientapp_link| replace:: ``flower-client-app`` .. |flowernext_serverapp_link| replace:: ``flower-server-app`` +.. |flower_simulation_link| replace:: ``flower-simulation`` .. _clientapp_link: ref-api/flwr.client.ClientApp.html .. _serverapp_link: ref-api/flwr.server.ServerApp.html .. _startclient_link: ref-api/flwr.client.start_client.html .. _startserver_link: ref-api/flwr.server.start_server.html .. _startsim_link: ref-api/flwr.simulation.start_simulation.html -.. _runsimcli_link: ref-api/flwr.simulation.run_simulation_from_cli.html .. _runsim_link: ref-api/flwr.simulation.run_simulation.html .. _flowernext_superlink_link: ref-api-cli.html#flower-superlink .. _flowernext_clientapp_link: ref-api-cli.html#flower-client-app .. _flowernext_serverapp_link: ref-api-cli.html#flower-server-app +.. _flower_simulation_link: ref-api-cli.html#flower-simulation + Install update -------------- @@ -228,7 +229,7 @@ Simulation in CLI ... ) -- Run |runsimcli_link|_ in CLI and point to the ``server_app`` / ``client_app`` object in the +- Run |flower_simulation_link|_ in CLI and point to the ``server_app`` / ``client_app`` object in the code instead of executing the Python script. Here's an example (assuming the ``server_app`` and ``client_app`` objects are in a ``sim.py`` module):