patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

doc: extensions: zephyr-domain: fix object descriptions

Browse source 
Zephyr's domain code-sample object description was incorrectly yielded,
making Sphinx inventory (objects.inv) unusable on other projects that
need to use the domain via Intersphinx.

Ref. https://www.sphinx-doc.org/en/master/extdev/domainapi.html

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
This commit is contained in:
Gerard Marull-Paretas 2024-01-09 15:23:54 +01:00 committed by Carles Cufí
parent 2ca4ed205f
commit 9f4a7ba0f5
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/_extensions/zephyr/domain.py
View file

@ -249,7 +249,7 @@ class ZephyrDomain(Domain):
directives = {"code-sample": CodeSampleDirective} directives = {"code-sample": CodeSampleDirective}
object_types: Dict[str, ObjType] = { object_types: Dict[str, ObjType] = {
"code-sample": ObjType("code sample", "code-sample"), "code-sample": ObjType("code-sample", "code-sample"),
} }
initial_data: Dict[str, Any] = {"code-samples": {}} initial_data: Dict[str, Any] = {"code-samples": {}}
@ -267,9 +267,9 @@ class ZephyrDomain(Domain):
def get_objects(self): def get_objects(self):
for _, code_sample in self.data["code-samples"].items(): for _, code_sample in self.data["code-samples"].items():
yield ( yield (
code_sample["id"],
code_sample["name"], code_sample["name"],
code_sample["name"], "code-sample",
"code sample",
code_sample["docname"], code_sample["docname"],
code_sample["id"], code_sample["id"],
1, 1,