PyZipline/mkdocs.yml

site_name: PyZipline Documentation
site_url: !ENV [SITE_URL, 'https://seacogs.coastalcommits.com']
repo_name: CoastalCommits
repo_url: https://coastalcommits.com/SeaswimmerTheFsh/PyZipline
edit_uri: !ENV [EDIT_URI, 'src/branch/main/docs']
copyright: Copyright © 2023-2024, SeaswimmerTheFsh

site_author: SeaswimmerTheFsh
site_description: PyZipline is an API wrapper written in Python for the Zipline API.

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Usage: getting-started/usage.md
    - Versioning: getting-started/versioning.md
  - Reference:
    - ZiplineApi: ref/zipline.md
    - Utilities: ref/utils.md
    - Exceptions: ref/exceptions.md
    - Models: ref/models.md
    - Rest Adapter: ref/rest_adapter.md

plugins:
  - git-authors
  - search
  #- social
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [pyzipline]
          options:
            docstring_options:
              ignore_imit_summary: true
            summary: true
            show_root_toc_entry: false
            filters:
              - "!^___"

markdown_extensions:
  - abbr
  - attr_list
  - md_in_html
  - tables
  - pymdownx.blocks.details
  - pymdownx.blocks.admonition
  - pymdownx.saneheaders
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

theme:
  name: material
  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: cyan
      accent: light blue
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode

    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: cyan
      accent: light blue
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  features:
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tracking
    - navigation.top
    - navigation.sections
    - navigation.indexes
    - search.suggest
    - search.highlight
    - search.share
    - toc.follow
  logo: img/logo.png
  favicon: img/logo.png
  icon:
    repo: simple/forgejo

watch:
  - ./pyzipline