mkdocs.yml

site_name: cirkit
site_url: https://example.com
repo_url: https://github.com/april-tools/cirkit
nav:
  - Getting Started: 'index.md'
  - Notebooks:
    - Overview: 'notebooks/README.md'
    - Overview:
      - nb1: 'notebooks/learning-a-circuit.ipynb'
      - nb2: 'notebooks/region-graphs-and-parametrisation.ipynb'
      - nb3: 'notebooks/sum-of-squares-circuits.ipynb'
      - nb4: 'notebooks/compilation-options.ipynb'
      - nb5: 'notebooks/learning-a-circuit-with-pic.ipynb'
      - nb6: 'notebooks/logic-circuits.ipynb'
      - nb7: 'notebooks/compression-cp-factorization.ipynb'
      - nb8: 'notebooks/generative-vs-discriminative-circuit.ipynb'
  - API documentation: 'api/'
plugins:
  - search
  - autorefs
  - mkdocs-jupyter 
  - gen-files:
      scripts:
        - scripts/generate_api_pages.py
  - literate-nav:
      nav_file: overview.md
  - section-index
  - mkdocstrings:
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://pytorch.org/docs/stable/objects.inv
          options:
            docstring_style: google
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            show_if_no_docstring: true
theme:
  name: "material"
  logo: "assets/logo.png"
  palette:
    primary: blue
    accent: orange
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow
markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - toc:
      permalink: "¤"
extra_javascript:
  - js/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js
extra_css:
   - css/style.css
   - https://unpkg.com/katex@0/dist/katex.min.css