mkdocs.yml

# Project information
site_name: PolyKin
site_url: https://hugomvale.github.io/polykin/
site_author: Hugo Vale
site_description: >-
  An open-source polymerization kinetics library for Python.

# Repository
repo_name: HugoMVale/polykin
repo_url: https://github.com/HugoMVale/polykin
edit_uri: "" #disables edit button

# Copyright
copyright: Copyright © 2022 - 2024 Hugo Vale

# Configuration
theme:
  name: material
  language: en
  features:
    - search.highlight
    - search.suggest
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.path
    # - navigation.expand
    - navigation.top
    - toc.follow
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono

watch:
  - src/polykin
  - docs/tutorials
  - docs/reference

# Plugins
plugins:
  - search
  - autorefs
  - markdown-exec
  - table-reader
  #- bibtex:
  #    bib_file: "docs/bibliography/bibliography.bib"
  #    csl_file: "docs/bibliography/american-chemical-society.csl"
  # - gen-files:
  #     scripts:
  #       - docs/reference/gen_reference.py
  - literate-nav:
      nav_file: _SUMMARY.md
  # - gallery:
  #     examples_dirs: docs/tutorials
  #     gallery_dirs: docs/generated/gallery
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          #        import:
          #          - https://docs.python.org/3/objects.inv
          options:
            modernize_annotations: true
            docstring_section_style: spacy
            group_by_category: false
            # show_category_heading: true
            show_source: true
            members_order: alphabetical
            docstring_style: numpy
            show_root_toc_entry: false
            show_bases: false
            separate_signature: true
            show_signature_annotations: true
            inherited_members: true
            merge_init_into_class: false
            show_symbol_type_toc: true
            show_category_heading: false
            extensions:
              - griffe_inherited_docstrings
  - mkdocs-jupyter:
      include: ["*.ipynb"]
      include_source: false
      ignore_h1_titles: true

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.highlight
  - pymdownx.magiclink
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.snippets:
      base_path:
        - docs
      check_paths: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: "¤"

extra_javascript:
  - javascripts/katex.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js

extra_css:
  - css/mkdocstrings.css
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css

# Customization
extra:
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/HugoMVale
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/polykin/
    - icon: fontawesome/brands/linkedin
      link: https://de.linkedin.com/in/hugo-vale-8b65948a

nav:
  - Home:
      - index.md
      - Installation: installation.md
  # - generated/gallery
  - Tutorials: tutorials/
  - API Reference:
      - Chemical Kinetics:
          - Coefficients: reference/kinetics/coefficients/
          - Emulsion Polymerization: reference/kinetics/emulsion/
      - Copolymerization: reference/copolymerization/
      - Distributions: reference/distributions/
      - Mathematics: reference/math/
      - Properties:
          - reference/properties/index.md
          - Equations: reference/properties/equations/index.md
          - Diffusion: reference/properties/diffusion/
          - PVT Polymer: reference/properties/pvt_polymer/
          - Thermal Conductivity: reference/properties/thermal_conductivity/
          - Vaporization Enthalpy: reference/properties/vaporization_enthalpy/
          - Viscosity: reference/properties/viscosity/
      - Reactors:
          - Residence Time Distributions: reference/reactors/rtd/
      - Thermodynamics:
          #- reference/thermo/index.md
          - Activity Coeff. Models: reference/thermo/acm/
          - Equations of State: reference/thermo/eos/
      - Transport Phenomena:
          - Fluid Flow: reference/transport/flow/
          - Heat & Mass Transfer: reference/transport/hmt/
          - Transient Diffusion: reference/transport/diffusion/
      - Step-Growth Polymerization:
          - Analytical Solutions: reference/stepgrowth/solutions.md
      - Utils:
          - Exceptions: reference/utils/exceptions.md
          - Types: reference/utils/types.md