mkdocs.yml

site_name: Edgy
site_description: 🔥 The perfect ORM to work with complex databases 🔥.
site_url: https://edgy.dymmond.com
docs_dir: docs-generated
site_dir: site
theme:
  name: "material"
  custom_dir: docs-generated/overrides
  language: en
  palette:
    - scheme: "default"
      primary: "pink"
      accent: "red"
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: "material/lightbulb"
        name: "Switch to dark mode"
    - scheme: "slate"
      media: "(prefers-color-scheme: dark)"
      primary: "pink"
      accent: "red"
      toggle:
        icon: "material/lightbulb-outline"
        name: "Switch to light mode"
  favicon: statics/images/favicon.ico
  logo: statics/images/white.png
  features:
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    - content.code.select
    - navigation.indexes
    - navigation.path

repo_name: dymmond/edgy
repo_url: https://github.com/dymmond/edgy
edit_uri: ""
extra_css:
  - stylesheets/extra.css
plugins:
  - search
  - meta-descriptions:
      export_csv: false
      quiet: false
      enable_checks: false
      min_length: 50
      max_length: 160
      trim: false
  - mkdocstrings:
      handlers:
        python:
          options:
            extensions:
              - griffe_typingdoc
            show_root_heading: true
            show_if_no_docstring: true
            preload_modules: [databasez]
            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

nav:
  - Edgy: "index.md"
  - Getting Started:
      - "getting-started/index.md"
      - Install and First Query: "getting-started/install-and-first-query.md"
      - First Migration Cycle: "getting-started/first-migration-cycle.md"
  - Concepts:
      - Architecture Overview: "concepts/architecture.md"
      - Request and Query Lifecycle: "concepts/request-lifecycle.md"
      - Component Interactions: "concepts/component-interactions.md"
  - Tutorials:
      - "tutorials/index.md"
      - Build a Ravyn API with Edgy: "tutorials/build-a-ravyn-api.md"
      - Multi-Database and Schema Workflow: "tutorials/multi-db-and-schema-workflow.md"
  - How-To Guides:
      - "guides/index.md"
      - Developer Workflow: "guides/developer-workflow-local-dev-test-debug.md"
  - Core:
      - Connection: "connection.md"
      - Models: "models.md"
      - Declarative Models: "declarative-models.md"
      - Reflection:
          - Reflection: "reflection/reflection.md"
          - Automatic Reflection: "reflection/autoreflection.md"
      - Embedding: "embedding.md"
      - Managers: "managers.md"
      - Fields:
          - "fields/index.md"
          - Postgresql fields: "fields/postgres.md"
          - Customizing fields: "fields/custom.md"
      - File Handling: "file-handling.md"
      - Queries:
          - Queries: "queries/queries.md"
          - Bulk operations: "queries/bulk.md"
          - SQLAlchemy Compatibility Mode: "queries/sqlalchemy-compatibility.md"
          - The Q Operator: "queries/q.md"
          - Combined Queries: "queries/combined-queries.md"
          - Annotations: "queries/annotate.md"
          - Secrets: "queries/secrets.md"
          - Related Name: "queries/related-name.md"
          - Many-to-One relations: "queries/many-to-one.md"
          - ManyToMany: "queries/many-to-many.md"
          - Prefetch Related: "queries/prefetch.md"
      - Transactions: "transactions.md"
  - Features:
      - Signals: "signals.md"
      - Admin: "admin/admin.md"
      - Relationships: "relationships.md"
      - Pagination & Linked Lists: "pagination.md"
      - Reference ForeignKey: "reference-foreignkey.md"
      - Marshalls: "marshalls.md"
      - ContentTypes:
          - Introduction: "contenttypes/intro.md"
          - ContentTags - or how to replace elastic search: "contenttypes/replace-elasticsearch.md"
      - Permissions & Passwords:
          - Permissions: "permissions/intro.md"
          - Passwords: "permissions/passwords.md"
      - Tenancy:
          - Edgy: "tenancy/edgy.md"
          - Contrib: "tenancy/contrib.md"
      - Registry: "registry.md"
      - CLI Commands: "cli/commands.md"
      - Shell Support: "shell.md"
      - Inspect DB: "inspectdb.md"
      - Migrations:
          - Discovery: "migrations/discovery.md"
          - Migrations: "migrations/migrations.md"
      - Settings: "settings.md"
  - Extras:
      - Exceptions: "exceptions.md"
      - Troubleshooting: "troubleshooting.md"
      - Tips and Tricks: "tips-and-tricks.md"
      - Extensions: "extensions.md"
  - Testing:
      - "testing/index.md"
      - Test Client: "testing/test-client.md"
      - Model Factory: "testing/model-factory.md"
  - Debugging: "debugging.md"
  - API Reference:
      - "references/index.md"
      - Model: "references/models.md"
      - StrictModel: "references/strict-model.md"
      - ReflectModel: "references/reflect-model.md"
      - Manager: "references/manager.md"
      - QuerySet: "references/queryset.md"
      - Signals: "references/signals.md"
      - Marshall: "references/marshall.md"
      - Fields:
          - Field: "references/fields.md"
          - OneToOne: "references/one-to-one.md"
          - ForeignKey: "references/foreignkey.md"
          - ManyToMany: "references/many-to-many.md"
          - Reference ForeignKey: "references/reference-foreign-key.md"
      - Registry: "references/registry.md"
      - Schema: "references/schemas.md"
      - Database: "references/database.md"
  - About:
      - Edgy Contributors: "edgy-people.md"
      - Contributing: "contributing.md"
      - Sponsorship: "sponsorship.md"
  - Release Notes: "release-notes.md"

markdown_extensions:
  - attr_list
  - toc:
      permalink: true
  - admonition
  - abbr
  - def_list
  - footnotes
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      use_pygments: true
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - md_in_html

extra:
  alternate:
    - link: /
      name: English
      lang: en
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/dymmond/edgy
    - icon: fontawesome/brands/discord
      link: https://discord.gg/XVeWXSrJ