From 5e8a4431804c7095588b4ecbb890fa9498ff2a21 Mon Sep 17 00:00:00 2001 From: "Mike A." Date: Tue, 5 Aug 2025 15:38:36 +0200 Subject: [PATCH] docs: small autoapi improvements --- docs/.gitignore | 1 + docs/conf.py | 2 ++ docs/index.md | 2 +- 3 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 docs/.gitignore diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..10e83c6 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +reference/ \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index f595d85..6041c7b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,7 +31,9 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # -- AutoAPI Options --------------------------------------------------------- autoapi_dirs = ["../findmy/"] +autoapi_root = "reference/" autoapi_add_toctree_entry = False +autoapi_keep_files = True autoapi_options = [ "members", "undoc-members", diff --git a/docs/index.md b/docs/index.md index 6b4b655..f292edc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -30,6 +30,6 @@ reveng/index ```{toctree} :maxdepth: 1 -API Reference +API Reference genindex ```