mkdocs.yml

site_name: ConvDO
site_description: Convolutional Differential Operators with PyTorch.
site_author: Qiang Liu
site_url: https://qiauil.github.io/ConvDO

repo_url: https://github.com/qiauil/ConvDO
repo_name: qiail/ConvDO
edit_uri: ""  # No edit button, as some of our pages are in /docs and some in /examples via symlink, so it's impossible for them all to be accurate

theme:
    name: material
    features:
        #- navigation.sections  # Sections are included in the navigation on the left.
        - toc.integrate  # Table of contents is integrated on the left; does not appear separately on the right.
        - header.autohide  # header disappears as you scroll
    palette:
        - scheme: default
          primary: deep purple
          accent: amber
          toggle:
             icon: material/weather-night
             name: Switch to dark mode
        - scheme: slate
          primary: deep purple
          accent: amber
          toggle:
             icon: material/weather-sunny
             name: Switch to light mode
    icon:
        repo: fontawesome/brands/github  # GitHub logo in top right
    logo: assets/logo/ConvDO_white.svg

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/qiauil


strict: true  # Don't allow warnings during the build process

markdown_extensions:
    - pymdownx.arithmatex:  # Render LaTeX via MathJax
        generic: true
    - pymdownx.superfences  # Seems to enable syntax highlighting when used with the Material theme.
    - pymdownx.details  # Allowing hidden expandable regions denoted by ???
    - pymdownx.snippets:  # Include one Markdown file into another
        base_path: docs
    - admonition
    - toc:
        permalink: "¤"  # Adds a clickable permalink to each section heading
        toc_depth: 4
    - pymdownx.arithmatex:
        generic: true

extra_javascript:
    - javascripts/mathjax.js
    - https://polyfill.io/v3/polyfill.min.js?features=es6
    - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

plugins:
    - search  # default search plugin; needs manually re-enabling when using any other plugins
    - autorefs  # Cross-links to headings
    - mknotebooks  # Jupyter notebooks
    - mkdocstrings:
        handlers:
            python:
                options:
                    inherited_members: true  # Allow looking up inherited methods
                    show_root_heading: true  # actually display anything at all...
                    show_root_full_path: true  # display full path
                    show_if_no_docstring: true
                    show_signature_annotations: true
                    separate_signature: true
                    show_source: true  # don't include source code
                    members_order: source  # order methods according to their order of definition in the source code, not alphabetical order
                    heading_level: 4
                    show_symbol_type_heading: true
                    docstring_style: google

nav:
    - 'Home': 'index.md'
    - 'Step to Step Examples': 
        - 'Divergence Operator': 'contents/examples/divergence.ipynb'
        - 'Operator with obstacles': 'contents/examples/obstacles.ipynb'
        - 'Optimization': 'contents/examples/optimization.ipynb'
    - 'Manual': 
        - 'Coordinate': 'contents/guide/coordinate.ipynb'
        - 'Meta Variables': 'contents/guide/meta.md'
        - 'Operators': 'contents/guide/operators.md'
        - 'Boundaries': 'contents/guide/boundaries.md'
        - 'Obstacles': 'contents/guide/obstacles.md'
        - 'Domains': 'contents/guide/domain.ipynb'
        - 'Operations': 'contents/guide/operations.md'