mkdocs.yml

# mkdocs.yml
# Top-level config for mkdocs
# See: https://www.mkdocs.org/user-guide/configuration/
site_name: Rerun Python APIs
site_url: https://ref.rerun.io/docs/python/
repo_url: https://github.com/rerun-io/rerun/

# Use the material theme
# Override some options for nav: https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
theme:
  name: "material"
  features:
    - navigation.indexes
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking

plugins:
  - search # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/
  - mkdocstrings: # https://mkdocstrings.github.io/usage/#global-options
      custom_templates: rerun_py/docs/templates # Override the function template. NOTE: relative to working directory. (https://github.com/mkdocstrings/mkdocstrings/issues/477)
      handlers:
        python:
          paths: ["rerun_sdk"] # Lookup python modules relative to this path
          import: # Cross-references for python and numpy
            - https://arrow.apache.org/docs/objects.inv
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://ipython.readthedocs.io/en/stable/objects.inv
          options: # https://mkdocstrings.github.io/python/usage/#globallocal-options
            docstring_section_style: spacy # list spacy table
            docstring_style: numpy
            heading_level: 3
            filters: [
                "!__attrs_clear__", # For internal use
                "!^_[^_]", # Hide things starting with a single underscore
                "!as_component_batches", # Inherited from AsComponents
                "!indicator", # Inherited from Archetype
                "!num_instances", # Inherited from AsComponents
              ]
            inherited_members: true
            members_order: source # The order of class members
            merge_init_into_class: false # Not compatible with `inherited_members`
            show_if_no_docstring: false # We intentionally hide archetype fields
            show_source: no
  - gen-files: # https://oprypin.github.io/mkdocs-gen-files
      scripts:
        - docs/gen_common_index.py
  - literate-nav: # https://oprypin.github.io/mkdocs-literate-nav
      nav_file: SUMMARY.txt
  - redirects: # https://github.com/mkdocs/mkdocs-redirects
      redirect_maps:
        "index.md": "common/index.md"

# https://www.mkdocs.org/user-guide/configuration/#markdown_extensions
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/
markdown_extensions:
  - admonition # https://squidfunk.github.io/mkdocs-material/reference/admonitions/
  - pymdownx.highlight # https://mkdocstrings.github.io/theming/#syntax-highlighting
  - pymdownx.superfences
  - toc:
      toc_depth: 4

# Some extra styling
extra_css:
  - css/mkdocstrings.css

# https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
extra:
  version:
    provider: mike
    default: latest