From 1b7dd8da67e5c1d2c777538e94f48d013ebadbd0 Mon Sep 17 00:00:00 2001 From: Sergei Kliuikov Date: Thu, 7 Nov 2024 14:38:40 -0800 Subject: [PATCH] Feature(docs): Add inventory file for intersphinx support. --- mkdocs.yml | 4 ++++ requirements/requirements-documentation.txt | 3 +++ 2 files changed, 7 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index a031dd69b..afd657f59 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,6 +13,10 @@ markdown_extensions: - toc: anchorlink: True +plugins: + - mkdocstrings: + enable_inventory: true + nav: - Home: 'index.md' - Tutorial: diff --git a/requirements/requirements-documentation.txt b/requirements/requirements-documentation.txt index 2cf936ef3..977c27389 100644 --- a/requirements/requirements-documentation.txt +++ b/requirements/requirements-documentation.txt @@ -3,3 +3,6 @@ mkdocs==1.6.0 # pylinkvalidator to check for broken links in documentation. pylinkvalidator==0.3 + +# to generate objects.inv +mkdocstrings-python~=1.12.2 \ No newline at end of file