From 62ccf46b9cf8eae9bd6a46842bb38acb186fb15f Mon Sep 17 00:00:00 2001 From: Rahix Date: Sun, 19 Sep 2021 15:45:42 +0200 Subject: [PATCH 1/3] feat(docs): Add --open flag to build-docs.sh Can be used to build docs and directly open them in the users default web-browser: ./Documentation/build-docs.sh --open --- Documentation/build-docs.sh | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Documentation/build-docs.sh b/Documentation/build-docs.sh index 09c32eca..2cb61648 100755 --- a/Documentation/build-docs.sh +++ b/Documentation/build-docs.sh @@ -4,3 +4,7 @@ set -e cd "$(dirname "$0")" sphinx-build -b html . ./output + +if [ "$1" = "--open" ]; then + xdg-open ./output/index.html +fi -- GitLab From 2c3ad4fca2cc75e329b0f3d13fb979ffe62614c1 Mon Sep 17 00:00:00 2001 From: Rahix Date: Sun, 19 Sep 2021 15:57:29 +0200 Subject: [PATCH 2/3] fix(docs): Fix issue_8945 hack for Sphinx 4.0 --- Documentation/conf.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Documentation/conf.py b/Documentation/conf.py index 94867ea8..b21f01db 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -167,7 +167,10 @@ def fix_issue_8945(): "_Complex", "complex", ]: - c_domain._keywords.remove(kw) + if kw in c_domain._keywords: + c_domain._keywords.remove(kw) + if hasattr(c_domain, "_macroKeywords") and kw in c_domain._macroKeywords: + c_domain._macroKeywords.remove(kw) def parse_xref_object(self): name = self._parse_nested_name() -- GitLab From f95711e12cd23ded339bb7521ebcfcfa92d2c1f4 Mon Sep 17 00:00:00 2001 From: Rahix Date: Sun, 19 Sep 2021 15:58:05 +0200 Subject: [PATCH 3/3] docs(card10.cfg): Add config option for flashlight LED Add a config option to indicate that a flashlight LED was soldered onto the harmonic board. --- Documentation/card10-cfg.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Documentation/card10-cfg.rst b/Documentation/card10-cfg.rst index f77a345b..03c1c1ec 100644 --- a/Documentation/card10-cfg.rst +++ b/Documentation/card10-cfg.rst @@ -64,4 +64,6 @@ Option name Type Description ``bsec_offset`` Integer Temperature offset in .1 K. Example: Set to `-14` if temperature reads 1.4 "C" to high. Default: -2.2 K (appropriate for a card10 without a case, connected to USB and with BLE active in vertical orientation). ------------------ ---------- ----------- ``battery_check`` Boolean Whether the low battery check should be enabled (default ``true``). **Warning**: Do not use this unless you know what you're doing. This option is only meant to be used on devices with a broken PMIC ADMUX connection. +------------------ ---------- ----------- +``has_flashlight`` Boolean Whether the flashlight LED was soldered onto the harmonic board. Can be used by apps to optionally enable flashlight features. ================== ========== =========== -- GitLab