From b203d171b404b48daedc593bf44b68b6815f9b57 Mon Sep 17 00:00:00 2001 From: SR Murthy Date: Sat, 20 Apr 2024 00:36:27 +0100 Subject: [PATCH] doc: build docs with Sphinx-style object inventory to support cross referencing from Sphinx documentation projects (#2842) --- mkdocs.yml | 1 + news/2841.doc.md | 1 + 2 files changed, 2 insertions(+) create mode 100644 news/2841.doc.md diff --git a/mkdocs.yml b/mkdocs.yml index fe966e05a8..ce06e16a85 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -35,6 +35,7 @@ plugins: - "mkdocs-version-annotations": version_added_admonition: "tip" - mkdocstrings: + enable_inventory: true handlers: python: options: diff --git a/news/2841.doc.md b/news/2841.doc.md new file mode 100644 index 0000000000..803f2cc2c7 --- /dev/null +++ b/news/2841.doc.md @@ -0,0 +1 @@ +Build docs with object inventory to support cross references from Sphinx documentation projects. \ No newline at end of file