Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(framework:skip) Update link for run-simulation-from-cli #3382

Merged
merged 5 commits into from
May 22, 2024
Merged

docs(framework:skip) Update link for run-simulation-from-cli #3382

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0be7c56
Remove unused links
chongshenng May 1, 2024
eb38972
Merge branch 'main' into remove-run-simulation-cli-links
danieljanes May 1, 2024
4ac3db8
Add link to ref-api-cli
chongshenng May 1, 2024
53b3533
Merge branch 'main' into remove-run-simulation-cli-links
chongshenng May 14, 2024
2da5972
Merge branch 'main' into remove-run-simulation-cli-links
chongshenng May 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,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 -------------------------------------------------
Expand Down
4 changes: 1 addition & 3 deletions doc/source/how-to-upgrade-to-flower-next.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ 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``
Expand All @@ -32,7 +31,6 @@ Let's dive in!
.. _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
Expand Down Expand Up @@ -228,7 +226,7 @@ Simulation in CLI
...
)

- Run |runsimcli_link|_ in CLI and point to the ``server_app`` / ``client_app`` object in the
- Run :code:`flower-simulation` in CLI and point to the ``server_app`` / ``client_app`` object in the
chongshenng marked this conversation as resolved.
Show resolved Hide resolved
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):

Expand Down