site_name: Manticore CockroachDB Client
site_description: A Python client for CockroachDB with sync and async support
site_url: https://manticoretechnology.github.io/manticore-cockroachdb/
repo_url: https://github.com/manticoretechnology/manticore-cockroachdb
repo_name: manticoretechnology/manticore-cockroachdb
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    primary: indigo
    accent: indigo
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.expand
    - navigation.indexes
    - content.code.copy
    - content.code.annotate

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - def_list
  - tables

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [manticore_cockroachdb]
          options:
            show_source: true
            heading_level: 3
            show_category_heading: true
            show_if_no_docstring: false
            docstring_style: google
            show_root_heading: true
            show_root_full_path: false
            members_order: source

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Usage Guide:
    - usage/index.md
    - Sync Operations: usage/sync.md
    - Async Operations: usage/async.md
    - Migrations: usage/migrations.md
    - CRUD Operations: usage/crud.md
    - Advanced Usage: usage/advanced.md
  - API Reference:
    - api/index.md
    - Database: api/database.md
    - AsyncDatabase: api/async_database.md
    - Migrations: api/migrations.md
    - Table: api/table.md
    - AsyncTable: api/async_table.md
    - Exceptions: api/exceptions.md
  - Examples:
    - examples/index.md
    - Sync Examples: examples/sync_examples.md
    - Async Examples: examples/async_examples.md
    - Migration Examples: examples/migration_examples.md
  - Contributing: contributing.md
  - Changelog: changelog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/manticoretechnology
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/manticore-cockroachdb/

copyright: Copyright &copy; 2023-2024 Manticore Technology 