mkdocs.yml

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: fold
# Configuration
theme:
  favicon: assets/images/lightning.png
  # logo: simple/zapier
  icon:
    repo: fontawesome/brands/github
    logo: simple/loop
    # edit: material/pencil
    view: material/lock
  name: material
  custom_dir: docs/overrides
  language: en
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: classic
      accent: green
      # primary: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      accent: lime
      # primary: lime
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.sections
    # - navigation.expand
    # - navigation.prune
    - navigation.indexes
    - navigation.top
    - navigation.path
    - navigation.footer
    - toc.follow
    # - toc.integrate
    - search.suggest
    - search.highlight
    - search.share
    # - header.autohide
    - announce.dismiss
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - content.footnote.tooltips
    - content.code.copy
    # - content.action.edit
    - content.action.view
# Repository
copyright: Copyright © 2015 - 2024 ActurialCapital
repo_url: https://github.com/ActurialCapital/
repo_name: acturialcapital
extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/acturialcapital
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/j-mr
  version:
    provider: mike
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
extra_css:
  - assets/css/extra.css
  - assets/css/termynal.css
  - assets/css/custom.css
plugins:
  # - typeset
  # - meta
  # - optimize
  # - git-authors
  - glightbox
  - git-revision-date-localized:
      enable_creation_date: true
      type: date
  - search:
      separator:
        '[\s\-\.]'
        # prebuild_index: true
  # - autorefs
  - tags
  - gen-files:
      scripts:
        - docs/scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [fold]
          options:
            show_bases: true
            heading_level: 2
            show_root_heading: true
            show_source: false
            show_csource_code: false
            show_root_members_full_path: false
            show_object_full_path: false
            show_category_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_style: numpy
            filters:
              - "!^_"
              - "!^__"
            show_signature: true
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: false
            docstring_section_style: spacy
            group_by_category: true
            show_if_no_docstring: false
            annotations_path: brief
            # members_order: source
  - git-committers:
      repository: ActurialCapital/fold
      branch: main
markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      # toc_depth: 4
  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.critic
extra_javascript:
  - assets/js/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - assets/js/termynal.js
  - assets/js/termynal.min.js
  - assets/js/custom.js

# use_directory_urls: false

nav:
- API: 
  - api/index.md