mkdocs.yml

site_name: Automata
site_description: Automata is a Python 3 library which implements the structures and algorithms for finite automata, pushdown automata, and Turing machines.
site_url: https://automata.site.to.be.created.org
repo_url: https://github.com/caleb531/automata
repo_name: automata
edit_uri: blob/main/docs/
theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
  features:
    - search.suggest
    - search.highlight
    - toc.integrate
    - navigation.top
    - navigation.indexes
    - navigation.tabs
    - content.code.copy
  # - navigation.tabs.sticky
  # - navigation.tracking
  # - navigation.expand
  # - navigation.sections
  # - header.autohide
  icon:
    repo: fontawesome/brands/github
  logo: assets/img/logo.svg
  favicon: assets/img/favicon.png
  language: en
plugins:
  - search:
      separator: '[\s\-\.]'
      min_length: 2
      indexing:
        "full"
        # media_type: print
        # enabled_if_env: ENABLE_PDF_EXPORT
  - macros:
      enabled_if_env: ENABLE_PDF_EXPORT
  - mkdocstrings:
      enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
      default_handler: python
      handlers:
        python:
          options:
            show_source: false
            docstring_style: "numpy"
            filters:
              - "!^_"
              - "!^__"
markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      # auto_title: true
      # anchor_linenums: true
      # linenums: true
      # linenums_style: pymdownx-inline
  - pymdownx.tasklist:
      clickable_checkbox: true
      custom_checkbox: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.betterem
  - admonition
  - pymdownx.details
  - footnotes
  - attr_list
  - md_in_html
  - tables
extra:
  social:
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/automata-lib/
      name: Package on PyPI
# extra_css:
#   - stylesheets/extra.css
# extra_javascript:
#   - javascripts/extra.js
copyright: Copyright © 2016 - 2025 Caleb Evans
nav:
  - Introduction:
      - index.md
      - migration.md
      - characteristics.md
  - Examples:
      - examples/fa-examples.md
      - examples/perf-examples.md
  - API:
      - api/index.md
      - Class Automaton: api/class-automaton.md
      - Finite Automaton (FA):
          - api/fa/class-fa.md
          - Deterministic (DFA):
              - api/fa/class-dfa.md
          - Non-Deterministic (NFA):
              - api/fa/class-nfa.md
          - Generalized Non-Deterministic (GNFA):
              - api/fa/class-gnfa.md
      - Pushdown Automaton (PDA):
          - api/pda/class-pda.md
          - Deterministic (DPDA):
              - api/pda/class-dpda.md
          - Non-Deterministic (NPDA):
              - api/pda/class-npda.md
      - Turing Machine (TM):
          - api/tm/class-tm.md
          - Deterministic (DTM):
              - api/tm/class-dtm.md
          - Non-Deterministic (NTM):
              - api/tm/class-ntm.md
          - Multi-Tape Non-Deterministic (MNTM):
              - api/tm/class-mntm.md
      - Regular Expressions:
          - api/regular-expressions.md
      - Base exception classes:
          - api/base-exception-classes.md
      - Turing machine exceptions:
          - api/tm/tm-exception-classes.md
  - Community:
      - people.md