site_name: SQLAlchemy-PGView
site_description: SQLAlchemy extension for PostgreSQL views and materialized views
site_url: https://d3vyce.github.io/sqlalchemy-pgview
repo_url: https://github.com/d3vyce/sqlalchemy-pgview
repo_name: d3vyce/sqlalchemy-pgview
edit_uri: edit/main/docs/

theme:
    name: material
    palette:
        - media: "(prefers-color-scheme: light)"
          scheme: default
          primary: indigo
          accent: indigo
          toggle:
              icon: material/brightness-7
              name: Switch to dark mode
        - media: "(prefers-color-scheme: dark)"
          scheme: slate
          primary: indigo
          accent: indigo
          toggle:
              icon: material/brightness-4
              name: Switch to light mode
    features:
        - navigation.instant
        - navigation.instant.prefetch
        - navigation.tracking
        - navigation.sections
        - navigation.expand
        - navigation.top
        - search.suggest
        - search.highlight
        - content.code.copy
        - content.code.annotate
        - content.tabs.link
    icon:
        repo: fontawesome/brands/github

plugins:
    - search
    - mkdocstrings:
          handlers:
              python:
                  options:
                      extensions:
                          - griffe_typingdoc
                      show_root_heading: true
                      show_if_no_docstring: true
                      inherited_members: true
                      members_order: source
                      separate_signature: true
                      unwrap_annotated: true
                      filters:
                          - '!^_'
                      merge_init_into_class: true
                      docstring_section_style: spacy
                      signature_crossrefs: true
                      show_symbol_type_heading: true
                      show_symbol_type_toc: true

markdown_extensions:
    - pymdownx.highlight:
          anchor_linenums: true
          line_spans: __span
          pygments_lang_class: true
    - pymdownx.inlinehilite
    - pymdownx.snippets
    - pymdownx.superfences
    - pymdownx.tabbed:
          alternate_style: true
    - admonition
    - pymdownx.details
    - pymdownx.emoji:
          emoji_index: !!python/name:material.extensions.emoji.twemoji
          emoji_generator: !!python/name:material.extensions.emoji.to_svg
    - attr_list
    - md_in_html
    - tables
    - toc:
          permalink: true

nav:
    - Home: index.md
    - User Guide:
          - Views: guide/views.md
          - Materialized Views: guide/materialized-views.md
          - Async Support: guide/async.md
          - Alembic Migrations: guide/alembic.md
          - Dependency Tracking: guide/dependencies.md
    - API Reference:
          - Views:
                - View: api/views/view.md
                - MaterializedView: api/views/materialized-view.md
                - AutoRefreshContext: api/views/auto-refresh-context.md
                - get_views: api/views/get-views.md
                - get_materialized_views: api/views/get-materialized-views.md
          - DDL Operations:
                - CreateView: api/ddl/create-view.md
                - DropView: api/ddl/drop-view.md
                - CreateMaterializedView: api/ddl/create-materialized-view.md
                - DropMaterializedView: api/ddl/drop-materialized-view.md
                - RefreshMaterializedView: api/ddl/refresh-materialized-view.md
          - Dependencies:
                - ViewInfo: api/dependencies/view-info.md
                - ViewDependency: api/dependencies/view-dependency.md
                - get_view_definition: api/dependencies/get-view-definition.md
                - get_all_views: api/dependencies/get-all-views.md
                - get_view_dependencies: api/dependencies/get-view-dependencies.md
                - get_dependency_order: api/dependencies/get-dependency-order.md
                - get_reverse_dependencies: api/dependencies/get-reverse-dependencies.md
          - Alembic:
                - CreateViewOp: api/alembic/create-view-op.md
                - DropViewOp: api/alembic/drop-view-op.md
                - CreateMaterializedViewOp: api/alembic/create-materialized-view-op.md
                - DropMaterializedViewOp: api/alembic/drop-materialized-view-op.md
                - RefreshMaterializedViewOp: api/alembic/refresh-materialized-view-op.md

extra:
    social:
        - icon: fontawesome/brands/github
          link: https://github.com/d3vyce/sqlalchemy-pgview