mkdocs.yml

# Set strict to true to turn warnings into errors to catch warnings within CI.
strict: true
theme:
  name: material
  # By default, fonts are pulled from Google on the Internet. To support offline usage, this is
  # disabled.
  highlightjs: true
  font: true
  palette:
    scheme: slate
    primary: green
    accent: yellow
  icon:
    logo: material/math-integral-box
    # GitHub specific.
    repo: fontawesome/brands/github
  favicon: static/math-integral-box.png
  features:
    - content.code.annotate
    - content.tabs.link
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
markdown_extensions:
  - admonition
  - pymdownx.keys
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - md_in_html
extra_css:
  - static/stylesheets/extra.css
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://cchteam.med.yale.edu/gitlab/computational-emergency-medicine/ed-pipeline
# This is needed to allow links to work when opened from the file system.
use_directory_urls: false
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          rendering:
            show_if_no_docstring: true
            show_signature_annotations: true
      watch:
        - src
  # Autodoc configuration.
  # https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  # This plugin is used to validate URLs (including some anchors).
  # Uncomment to build the docs with this validation enabled.
  # This is commented out by default because this requires network I/O to validate URLs, so it is
  # inherently not exactly reproducible. But this plugin is none-the-less helpful at detecting
  # incorrect URLs.
#  - htmlproofer:
#      raise_error: True
site_name: ed-pipline
copyright: Copyright © 2018-2022 DECILE
# GitHub Specific Configuration.
repo_name: ed-pipeline
repo_url: https://cchteam.med.yale.edu/gitlab/computational-emergency-medicine/ed-pipeline
edit_uri: edit/master/docs/user_guide/docs/
nav:
  - index.md
  - Code Reference: reference/