From 75e5ea89349bb04f37de2b731a8eecc75f9d9a6c Mon Sep 17 00:00:00 2001 From: Gaute Svanes Lunde Date: Tue, 10 Jan 2023 12:42:48 +0100 Subject: [PATCH] Doc dependencies (#24341) * doc: fix sphinx dependencies Fix dependencies to be set at Sphinx>=4.5 while keeping docutils at 0.17. Signed-off-by: Gaute Svanes Lunde * doc: renamed to README for inclusion in toc-tree Renamed file to from Readme.md to README.md for inclusion in the Sphinx ToC tree. Signed-off-by: Gaute Svanes Lunde * doc: Fixed link path Fixed a broken link path to `docs/guides/silabs_efr32_software_update.md`. Signed-off-by: Gaute Svanes Lunde Signed-off-by: Gaute Svanes Lunde --- docs/requirements.txt | 5 +++-- examples/contact-sensor-app/telink/{Readme.md => README.md} | 0 examples/thermostat/silabs/efr32/README.md | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) rename examples/contact-sensor-app/telink/{Readme.md => README.md} (100%) diff --git a/docs/requirements.txt b/docs/requirements.txt index a7e08d297e18ca..988f0b3f668058 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,5 @@ -Sphinx +docutils==0.17.1 +Sphinx>=4.5 sphinx-book-theme myst-parser -breathe +breathe>=4.34 diff --git a/examples/contact-sensor-app/telink/Readme.md b/examples/contact-sensor-app/telink/README.md similarity index 100% rename from examples/contact-sensor-app/telink/Readme.md rename to examples/contact-sensor-app/telink/README.md diff --git a/examples/thermostat/silabs/efr32/README.md b/examples/thermostat/silabs/efr32/README.md index 7851045590776a..bd80d425d29a87 100644 --- a/examples/thermostat/silabs/efr32/README.md +++ b/examples/thermostat/silabs/efr32/README.md @@ -361,7 +361,7 @@ tracking code inside the `trackAlloc` and `trackFree` function For the description of Software Update process with EFR32 example applications see -[EFR32 OTA Software Update](../../../docs/guides/silabs_efr32_software_update.md) +[EFR32 OTA Software Update](../../../../docs/guides/silabs_efr32_software_update.md) ## Building options