From c386a2a30d771d586d728dc35904bc6d343f4429 Mon Sep 17 00:00:00 2001 From: Hajar_hsh Date: Thu, 20 Feb 2025 18:36:14 +0100 Subject: [PATCH 1/6] Fix broken doc links and resolve dependency conflicts --- docs/development_controllers/chip-repl/index.md | 8 ++++---- docs/development_controllers/index.md | 4 ++-- docs/requirements.txt | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/development_controllers/chip-repl/index.md b/docs/development_controllers/chip-repl/index.md index b17962ab667446..7bd165ddbed88a 100644 --- a/docs/development_controllers/chip-repl/index.md +++ b/docs/development_controllers/chip-repl/index.md @@ -9,7 +9,7 @@ ``` - [Matter REPL](./matter-repl.md) -- [Intro](./Matter_REPL_Intro.ipynb) -- [Access Control](./Matter_Access_Control.ipynb) -- [Basic interactions](./Matter_Basic_Interactions.ipynb) -- [Fabric Commissioning](./Matter_Multi_Fabric_Commissioning.ipynb) +- [Intro](https://github.com/project-chip/connectedhomeip/blob/master/docs/development_controllers/chip-repl/Matter_REPL_Intro.ipynb) +- [Basic interactions](https://github.com/project-chip/connectedhomeip/blob/master/docs/development_controllers/chip-repl/Matter_Basic_Interactions.ipynb) +- [Access Control](https://github.com/project-chip/connectedhomeip/blob/master/docs/development_controllers/chip-repl/Matter_Access_Control.ipynb) +- [Multi Fabric Commissioning](https://github.com/project-chip/connectedhomeip/blob/master/docs/development_controllers/chip-repl/Matter_Multi_Fabric_Commissioning.ipynb) diff --git a/docs/development_controllers/index.md b/docs/development_controllers/index.md index dfc6b330b1753f..abdd8d7c2d3046 100644 --- a/docs/development_controllers/index.md +++ b/docs/development_controllers/index.md @@ -9,5 +9,5 @@ chip-repl/index chip-tool/index ``` -- [chip-tool](./chip-tool) -- [chip-repl](./chip-repl) +- [chip-tool](./chip-tool/index.md) +- [chip-repl](./chip-repl/index.md) diff --git a/docs/requirements.txt b/docs/requirements.txt index 87799ce782fe65..c53735cc17937b 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,6 +1,6 @@ -docutils==0.17.1 -Sphinx>=4.5 +docutils==0.21.2 +Sphinx==8.2.0 sphinx-book-theme -myst-parser +myst-parser>=2.0.0 breathe>=4.34 -pydata-sphinx-theme==0.14.4 +pydata-sphinx-theme==0.16.1 From 48a61c780365fb49874d9c911af54e1d43f5124c Mon Sep 17 00:00:00 2001 From: Hajar_hsh Date: Fri, 21 Feb 2025 09:33:49 +0100 Subject: [PATCH 2/6] Fix MyST cross-reference error in vs_code_development.md --- docs/examples/chef/README_DEVICE.md | 3 +++ docs/examples/chef/README_OTCLI.md | 3 +++ docs/examples/chef/README_SHELL.md | 3 +++ docs/platforms/esp32/vs_code_development.md | 5 +++-- examples/energy-management-app/linux/README.md | 2 +- 5 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 docs/examples/chef/README_DEVICE.md create mode 100644 docs/examples/chef/README_OTCLI.md create mode 100644 docs/examples/chef/README_SHELL.md diff --git a/docs/examples/chef/README_DEVICE.md b/docs/examples/chef/README_DEVICE.md new file mode 100644 index 00000000000000..8715aad4e930a4 --- /dev/null +++ b/docs/examples/chef/README_DEVICE.md @@ -0,0 +1,3 @@ +# Device Setup for Chef Example + +../shell/README_DEVICE.md diff --git a/docs/examples/chef/README_OTCLI.md b/docs/examples/chef/README_OTCLI.md new file mode 100644 index 00000000000000..f58f558240afcb --- /dev/null +++ b/docs/examples/chef/README_OTCLI.md @@ -0,0 +1,3 @@ +# Device Setup for Chef Example + +../shell/README_OTCLI.md diff --git a/docs/examples/chef/README_SHELL.md b/docs/examples/chef/README_SHELL.md new file mode 100644 index 00000000000000..6599d19b75abbc --- /dev/null +++ b/docs/examples/chef/README_SHELL.md @@ -0,0 +1,3 @@ +# Device Setup Guide for Chef Example + +../shell/README.md diff --git a/docs/platforms/esp32/vs_code_development.md b/docs/platforms/esp32/vs_code_development.md index 82852e1ce071e6..9974d53927c5a9 100644 --- a/docs/platforms/esp32/vs_code_development.md +++ b/docs/platforms/esp32/vs_code_development.md @@ -18,7 +18,8 @@ Follow [these](https://github.com/project-chip/connectedhomeip/edit/master/docs/VSCODE_DEVELOPMENT.md) steps to set up Visual Studio Code for Matter development. -### Linux +(linux)= +### Linux For Espressif esp32 devices: @@ -68,4 +69,4 @@ For Espressif esp32 devices: 1. Open connectedhomeip within WSL on Visual Studio Code. -1. Perform step 2 onwards from [Linux](#linux) guide. +1. Perform step 2 onwards from {ref}`linux` guide. diff --git a/examples/energy-management-app/linux/README.md b/examples/energy-management-app/linux/README.md index 37a4be4e7c0e2b..de6ccee10968f6 100644 --- a/examples/energy-management-app/linux/README.md +++ b/examples/energy-management-app/linux/README.md @@ -241,7 +241,7 @@ data (e.g. fabric info). - See chip-repl documentation in: - [Working with Python CHIP Controller](../../../docs/development_controllers/chip-repl/python_chip_controller_building.md) - - [Matter_REPL_Intro](../../../docs/development_controllers/chip-repl/Matter_REPL_Intro.ipynb) + - [Matter_REPL_Intro](https://github.com/project-chip/connectedhomeip/blob/master/docs/development_controllers/chip-repl/Matter_REPL_Intro.ipynb) ### Building chip-repl: From e2db95f2c049a44e54f62863c469d9e0c65a84b9 Mon Sep 17 00:00:00 2001 From: "Restyled.io" Date: Fri, 21 Feb 2025 08:42:35 +0000 Subject: [PATCH 3/6] Restyled by prettier-markdown --- docs/platforms/esp32/vs_code_development.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/platforms/esp32/vs_code_development.md b/docs/platforms/esp32/vs_code_development.md index 9974d53927c5a9..81730b38a048ac 100644 --- a/docs/platforms/esp32/vs_code_development.md +++ b/docs/platforms/esp32/vs_code_development.md @@ -19,6 +19,7 @@ Follow steps to set up Visual Studio Code for Matter development. (linux)= + ### Linux For Espressif esp32 devices: From 68beceb187d236576f578723d407beef6ba50fb1 Mon Sep 17 00:00:00 2001 From: Hajar SH <63333684+HaSH147@users.noreply.github.com> Date: Fri, 21 Feb 2025 16:22:13 +0100 Subject: [PATCH 4/6] Delete docs/examples/chef/README_DEVICE.md --- docs/examples/chef/README_DEVICE.md | 3 --- 1 file changed, 3 deletions(-) delete mode 100644 docs/examples/chef/README_DEVICE.md diff --git a/docs/examples/chef/README_DEVICE.md b/docs/examples/chef/README_DEVICE.md deleted file mode 100644 index 8715aad4e930a4..00000000000000 --- a/docs/examples/chef/README_DEVICE.md +++ /dev/null @@ -1,3 +0,0 @@ -# Device Setup for Chef Example - -../shell/README_DEVICE.md From ce0ed073d46e2003db1f2ef1e300c1dc45da6559 Mon Sep 17 00:00:00 2001 From: Hajar SH <63333684+HaSH147@users.noreply.github.com> Date: Fri, 21 Feb 2025 16:22:24 +0100 Subject: [PATCH 5/6] Delete docs/examples/chef/README_OTCLI.md --- docs/examples/chef/README_OTCLI.md | 3 --- 1 file changed, 3 deletions(-) delete mode 100644 docs/examples/chef/README_OTCLI.md diff --git a/docs/examples/chef/README_OTCLI.md b/docs/examples/chef/README_OTCLI.md deleted file mode 100644 index f58f558240afcb..00000000000000 --- a/docs/examples/chef/README_OTCLI.md +++ /dev/null @@ -1,3 +0,0 @@ -# Device Setup for Chef Example - -../shell/README_OTCLI.md From 9c14237e80a434260660029b4f1b39c794dab4b1 Mon Sep 17 00:00:00 2001 From: Hajar SH <63333684+HaSH147@users.noreply.github.com> Date: Fri, 21 Feb 2025 16:22:55 +0100 Subject: [PATCH 6/6] Delete docs/examples/chef/README_SHELL.md --- docs/examples/chef/README_SHELL.md | 3 --- 1 file changed, 3 deletions(-) delete mode 100644 docs/examples/chef/README_SHELL.md diff --git a/docs/examples/chef/README_SHELL.md b/docs/examples/chef/README_SHELL.md deleted file mode 100644 index 6599d19b75abbc..00000000000000 --- a/docs/examples/chef/README_SHELL.md +++ /dev/null @@ -1,3 +0,0 @@ -# Device Setup Guide for Chef Example - -../shell/README.md