From c16f45382e829f18b2c5f93f12948a18d42f45dc Mon Sep 17 00:00:00 2001 From: Arun Patole Date: Wed, 12 Jun 2024 00:50:58 +0530 Subject: [PATCH] Fix docs typos (#2629) This change fixes: - Typos in the `build_doc.sh` references. - Incorrect rendering of python code blocks on Flare API page. --- CONTRIBUTING.md | 4 ++-- docs/contributing.rst | 4 ++-- docs/real_world_fl/flare_api.rst | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc3554870a..fabed9dfbf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -83,13 +83,13 @@ python3 -m pip install nvflare[dev] To build the docs, please run. ```bash -./build_docs.sh --html +./build_doc.sh --html ``` Once built, you can view the docs in `docs/_build folder`. To clean the docs, please run ```bash -./build_docs.sh --clean +./build_doc.sh --clean ``` #### Signing your work diff --git a/docs/contributing.rst b/docs/contributing.rst index 466f9a3289..45f500a26a 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -97,14 +97,14 @@ To build the docs, please run. .. code:: bash - ./build_docs --html + ./build_doc.sh --html Once built, you can view the docs in ``docs/_build folder``. To clean the docs, please run .. code:: bash - ./build_docs --clean + ./build_doc.sh --clean Signing your work ^^^^^^^^^^^^^^^^^ diff --git a/docs/real_world_fl/flare_api.rst b/docs/real_world_fl/flare_api.rst index f40e3276c6..8165724061 100644 --- a/docs/real_world_fl/flare_api.rst +++ b/docs/real_world_fl/flare_api.rst @@ -42,7 +42,7 @@ Like with FLAdminAPI previously, :class:`AdminAPI