From cf1d022e4794189dae899f78ff23d25074a3ae6e Mon Sep 17 00:00:00 2001 From: Leon Pawelzik <78536240+leonpawelzik@users.noreply.github.com> Date: Fri, 15 Mar 2024 14:16:41 +0100 Subject: [PATCH] Add links to subpages in lakefs_spec API reference --- docs/_scripts/gen_api_ref_pages.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/_scripts/gen_api_ref_pages.py b/docs/_scripts/gen_api_ref_pages.py index 1f94aa9f..8c15e6c8 100644 --- a/docs/_scripts/gen_api_ref_pages.py +++ b/docs/_scripts/gen_api_ref_pages.py @@ -29,6 +29,14 @@ identifier = ".".join(parts) print("::: " + identifier, file=fd) + if identifier == "lakefs_spec": + print("\nSee also:\n", file=fd) + print("- [errors](errors.md): Module for error handling and custom exceptions.", file=fd) + print("- [spec](spec.md): Main module defining the lakeFS filesystem specification.", file=fd) + print("- [transaction](transaction.md): Module for handling transactions in the lakeFS filesystem.", file=fd) + print("- [util](util.md): Utility functions and helper classes for the lakeFS filesystem.", file=fd) + + mkdocs_gen_files.set_edit_path(full_doc_path, path) with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file: