From fb43015a7b65b47f1938a86eeb6c16e0b772bd1a Mon Sep 17 00:00:00 2001 From: Vladimir Marchenko Date: Tue, 19 Dec 2023 07:11:35 +0100 Subject: [PATCH] Doc style and typo fixes (#140) * Doc: minor style and typo fixes * Doc: Fixed broken link --- .gitignore | 2 +- Documentation/Doxygen/gen_doc.sh | 2 +- Documentation/Doxygen/src/mainpage.md | 2 +- Documentation/Doxygen/style_template/extra_stylesheet.css | 1 + 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index f2db0703..8b14c092 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,7 @@ *.bak Documentation/html/ Documentation/Doxygen/dsp.dxy -Documentation/Doxygen/history.txt +Documentation/Doxygen/src/history.txt DSP_Lib_TestSuite/build/ PythonWrapper/cmsisdsp.cp36-win_amd64.pyd PythonWrapper/internal.cp36-win_amd64.pyd diff --git a/Documentation/Doxygen/gen_doc.sh b/Documentation/Doxygen/gen_doc.sh index 24d7de0d..afc55e91 100755 --- a/Documentation/Doxygen/gen_doc.sh +++ b/Documentation/Doxygen/gen_doc.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # Version: 3.0 # Date: 2023-11-06 -# This bash script generates CMSIS-NN Documentation: +# This bash script generates CMSIS-DSP Documentation: # # Pre-requisites: # - bash shell (for Windows: install git for Windows) diff --git a/Documentation/Doxygen/src/mainpage.md b/Documentation/Doxygen/src/mainpage.md index 80ef9fcb..f33a65b9 100644 --- a/Documentation/Doxygen/src/mainpage.md +++ b/Documentation/Doxygen/src/mainpage.md @@ -44,7 +44,7 @@ The library is now tested on Fast Models building with cmake. Core M0, M4, M7, M ## Access to CMSIS-DSP {#pack} -CMSIS-DSP is actively maintained in the [**CMSIS-DSP GitHub repository**](https://github.com/ARM-software/CMSIS-RTX) and is released as a standalone [**CMSIS-DSP pack**](https://www.keil.arm.com/packs/cmsis-dsp-arm/versions/) in the [CMSIS-Pack format](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html). +CMSIS-DSP is actively maintained in the [**CMSIS-DSP GitHub repository**](https://github.com/ARM-software/CMSIS-DSP) and is released as a standalone [**CMSIS-DSP pack**](https://www.keil.arm.com/packs/cmsis-dsp-arm/versions/) in the [CMSIS-Pack format](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html). The table below explains the content of **ARM::CMSIS-DSP** pack. diff --git a/Documentation/Doxygen/style_template/extra_stylesheet.css b/Documentation/Doxygen/style_template/extra_stylesheet.css index b84f7d10..30980a64 100644 --- a/Documentation/Doxygen/style_template/extra_stylesheet.css +++ b/Documentation/Doxygen/style_template/extra_stylesheet.css @@ -1477,6 +1477,7 @@ div.headertitle dl { padding: 0 0 0 10px; + max-width: var(--max_textblock_width); } /* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */