From 2b22aa2b90f77db034bfcfd4ef289785c98fd4ff Mon Sep 17 00:00:00 2001 From: Ethan Ho <53266718+ethho@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:05:41 -0500 Subject: [PATCH 1/2] Explicitly set sys.path for mkdocs https://mkdocstrings.github.io/python/usage/#finding-modules --- docs/mkdocs.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/mkdocs.yaml b/docs/mkdocs.yaml index 0c9f6f37c..959c35cd8 100644 --- a/docs/mkdocs.yaml +++ b/docs/mkdocs.yaml @@ -111,6 +111,9 @@ plugins: default_handler: python handlers: python: + paths: + - "." + - /main/ options: filters: - "!^_" From cd432459c31c2674bf8703f22485e5f401bc2660 Mon Sep 17 00:00:00 2001 From: Ethan Ho <53266718+ethho@users.noreply.github.com> Date: Thu, 5 Sep 2024 13:07:16 -0500 Subject: [PATCH 2/2] Opt in to autorefs explicitly No longer default, see https://mkdocstrings.github.io/usage/?h=autorefs#cross-references-to-any-markdown-heading --- docs/mkdocs.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/mkdocs.yaml b/docs/mkdocs.yaml index 959c35cd8..52193bdca 100644 --- a/docs/mkdocs.yaml +++ b/docs/mkdocs.yaml @@ -107,6 +107,7 @@ theme: name: Switch to light mode plugins: - search + - autorefs - mkdocstrings: default_handler: python handlers: