Fix signature crossrefs

rerun-io · Oct 16, 2024 · 9086073 · 9086073
1 parent c46093b
commit 9086073
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git 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
@@ -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
@@ -16,4 +16,5 @@
     AnyColumn as AnyColumn,
     AnyComponentColumn as AnyComponentColumn,
     ComponentLike as ComponentLike,
+    ViewContentsLike as ViewContentsLike,
 )