From 9086073a80413aae766fcda541e2bee577028cce Mon Sep 17 00:00:00 2001 From: Jeremy Leibs Date: Wed, 16 Oct 2024 09:01:12 -0400 Subject: [PATCH] Fix signature crossrefs --- rerun_py/docs/gen_common_index.py | 7 +++++++ rerun_py/mkdocs.yml | 3 +++ rerun_py/rerun_sdk/rerun/dataframe.py | 1 + 3 files changed, 11 insertions(+) diff --git a/rerun_py/docs/gen_common_index.py b/rerun_py/docs/gen_common_index.py index 85406e215a5c..981b8eac0ad1 100755 --- a/rerun_py/docs/gen_common_index.py +++ b/rerun_py/docs/gen_common_index.py @@ -317,6 +317,7 @@ class Section: "RecordingView", "RRDArchive", "Schema", + "ViewContentsLike", ], show_tables=True, ), @@ -466,6 +467,12 @@ def make_slug(s: str) -> str: fd.write(" filters: []\n") if section.show_submodules: fd.write(" show_submodules: True\n") + # Helpful for debugging + if 0: + with mkdocs_gen_files.open(write_path, "r") as fd: + print("FOR SECTION", section.title) + print(fd.read()) + print() # Write out a table for the section in the index_file if section.show_tables: diff --git a/rerun_py/mkdocs.yml b/rerun_py/mkdocs.yml index 159f6c2b9007..530b4618bd55 100644 --- a/rerun_py/mkdocs.yml +++ b/rerun_py/mkdocs.yml @@ -47,6 +47,9 @@ plugins: load_external_modules: true preload_modules: - rerun_bindings + annotations_path: brief + signature_crossrefs: true + - gen-files: # https://oprypin.github.io/mkdocs-gen-files scripts: - docs/gen_common_index.py diff --git a/rerun_py/rerun_sdk/rerun/dataframe.py b/rerun_py/rerun_sdk/rerun/dataframe.py index 27a5305f7456..4b34e955a49f 100644 --- a/rerun_py/rerun_sdk/rerun/dataframe.py +++ b/rerun_py/rerun_sdk/rerun/dataframe.py @@ -16,4 +16,5 @@ AnyColumn as AnyColumn, AnyComponentColumn as AnyComponentColumn, ComponentLike as ComponentLike, + ViewContentsLike as ViewContentsLike, )