Skip to content
Snippets Groups Projects
mkdocs.yml 1.4 KiB
Newer Older
Remi Cresson's avatar
Remi Cresson committed
# mkdocs.yml
theme:
Remi Cresson's avatar
Remi Cresson committed
  logo: https://theia.sedoo.fr/wp-content-theia/uploads/sites/6/2020/05/Logo_DINAMIS_300px.png
Remi Cresson's avatar
Remi Cresson committed
  name: "material"
  icon:
    repo: fontawesome/brands/gitlab
  features:
    - content.code.annotate
    - toc.follow
Remi Cresson's avatar
Remi Cresson committed
    - navigation.instant
    - content.code.copy

Remi Cresson's avatar
Remi Cresson committed
plugins:
- search
- gen-files:
    scripts:
    - doc/gen_ref_pages.py
- mkdocstrings:
    watch:
    - dinamis_sdk/
- literate-nav:
    nav_file: SUMMARY.md
- section-index
- mermaid2

nav:
- Home: index.md
Remi Cresson's avatar
Remi Cresson committed
- Collections: collections.md
Remi Cresson's avatar
Remi Cresson committed
- Credentials: credentials.md
Remi Cresson's avatar
Remi Cresson committed
- Advanced use: advanced.md
Remi Cresson's avatar
Remi Cresson committed
- Additional resources: additional_resources.md
- Examples:
  - Processing: processing_examples.md
  - QGIS: qgis.md
- API reference:  reference/
Remi Cresson's avatar
Remi Cresson committed

# Customization
extra:
  feature:
    tabs: true
  social:
    - icon: fontawesome/brands/gitlab
Remi Cresson's avatar
Remi Cresson committed
      link: https://gitlab.irstea.fr/dinamis/dinamis-sdk
Remi Cresson's avatar
Remi Cresson committed

markdown_extensions:
  - attr_list
Remi Cresson's avatar
Remi Cresson committed
  - admonition
Remi Cresson's avatar
Remi Cresson committed
  - toc:
      permalink: true
      title: On this page
Remi Cresson's avatar
Remi Cresson committed
      toc_depth: 1-2
Remi Cresson's avatar
Remi Cresson committed
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
Remi Cresson's avatar
Remi Cresson committed
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
Remi Cresson's avatar
Remi Cresson committed

# rest of the navigation..
Remi Cresson's avatar
Remi Cresson committed
site_name: Dinamis-SDK
Remi Cresson's avatar
Remi Cresson committed
repo_url: https://gitlab.irstea.fr/dinamis/dinamis-sdk
repo_name: dinamis-sdk
docs_dir: doc/