mkdocs_rtd.yml

site_name: LMRTFY
site_url: https://www.lmrt.fyi
repo_url: https://github.com/lmrtfy/lmrtfy
site_author: lmrtfy
repo_name: lmrtfy/lmrtfy

docs_dir: 'docs/rtd'

theme:
  name: readthedocs
  highlight_js: true

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: sphinx

markdown_extensions:
  - markdown_include.include:
      base_path: .
  - abbr
  - admonition
  - attr_list
  - def_list
  - toc:
      baselevel: 2
      permalink: true

  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - GitHub repository: "https://github.com/lmrtfy/lmrtfy"
  - LMRTFY: 'index.md'