mkdocs.yml

site_name: Tablite
site_description: Tablite Documentation
site_url: https://root-11.github.io/tablite/
docs_dir: .
site_dir: site
repo_url: https://github.com/root-11/tablite/

# nav: items are in .pages file

theme:
  name: material
  palette:
    primary: deep purple
    accent: deep purple
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - toc.follow
    - search.suggest
    - search.highlight
  highlightjs: true
  hljs_languages:
    - python
    - bash
    - yaml
    - json
    - markdown
    - javascript
    - sql
    - http

plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          load_external_modules: true
          options:
            # https://mkdocstrings.github.io/python/usage/configuration/docstrings/
            docstring_style: google
            docstring_section_style: spacy
            show_if_no_docstring: true
            # https://mkdocstrings.github.io/python/usage/configuration/general/
            show_source: true
            # https://mkdocstrings.github.io/python/usage/configuration/headings/
            heading_level: 2
            show_root_heading: true
            show_root_toc_entry: true
            show_root_full_path: true
            show_root_members_full_path: true
            show_object_full_path: true
            show_category_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            # https://mkdocstrings.github.io/python/usage/configuration/members/
            inherited_members: true
            members_order: source
            show_submodules: true
            merge_init_into_class: true
            # https://mkdocstrings.github.io/python/usage/configuration/signatures/
            show_signature_annotations: true
  - mkdocs-jupyter:
      ignore_h1_titles: true
      include: ["*.ipynb"]
      execute: false
      include_source: true
  - mike
  - same-dir
  - awesome-pages
  - gen-files:
      scripts:
        - reference.py

extra:
  version:
    provider: mike
  default: latest
  generator: false # hide footer Made with Material

extra_css:
  - extra.css # 100% width, as we have wide tables

markdown_extensions:
  - abbr # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#abbreviations
  - attr_list
  - pymdownx.snippets