mkdocs.yml

   1 site_name: WRF-SFIRE
   2 site_url: https://WRF-SFIRE.readthedocs.io/en/latest/
   3 # these lines make the "edit on Github button"
   4 # repo_url: https://github.com/openwfm/WRF-SFIRE
   5 # edit_uri: edit/master/docs/
   6 site_description: WRF-SFIRE Documentation
   7 theme:
   8   name: readthedocs
   9   highlightjs: true
  10   features:
  11     - navigation.instant
  12 plugins:
  13   - search
  14   - mkdocstrings:
  15       handlers:
  16         # See: https://mkdocstrings.github.io/python/usage/
  17         python:
  18           options:
  19             docstring_style: sphinx
  20 markdown_extensions:
  21   - markdown_include.include:
  22       base_path: .
  23   - admonition
  24 nav:
  25     - Welcome: index.md
  26     - For Editors: build.md