Skip to content
Snippets Groups Projects
mkdocs.yml 1.98 KiB
Newer Older
  • Learn to ignore specific revisions
  • site_name: qim3d documentation
    site_url: https://platform.qim.dk/qim3d/
    site_author: Qim3d contributors
    site_description: Documentation for the Qim3d python library
    repo_url: https://lab.compute.dtu.dk/QIM/tools/qim3d
    
    fima's avatar
    fima committed
    repo_name: Gitlab
    
    fima's avatar
    fima committed
       
    
    fima's avatar
    fima committed
      - qim3d: index.md
      - Input & Output: io.md
    
    s193396's avatar
    s193396 committed
      - Data Generation: generate.md
    
    fima's avatar
    fima committed
      - Processing: processing.md
    
    fima's avatar
    fima committed
      - Visualization: viz.md
      - GUIs: gui.md
      - ML Models: models.md
      - CLI: cli.md
    
    fima's avatar
    fima committed
    
    
    fima's avatar
    fima committed
      - Release history: releases.md
    
    
    theme:
      language: en 
      name: material
      nav_position: top
      logo: assets/qim3d-icon.svg
      favicon: assets/qim3d-icon.svg
      features: 
        - navigation.tabs
    
    fima's avatar
    fima committed
        - navigation.tabs.sticky
    
    fima's avatar
    fima committed
        - navigation.sections
    
    fima's avatar
    fima committed
        - navigation.expand
        - navigation.instant
        # - navigation.tracking
    
        - toc.integrate
    
    fima's avatar
    fima committed
        # - toc.follow
    
        - search.suggest
        # - content.tabs.link
        # - content.code.annotation
        - content.code.copy
    
    fima's avatar
    fima committed
        - content.code.annotate
        - header.autohide
    
    
      palette:
        primary: white
        accent: orange
    
    
    extra_css:
      - stylesheets/extra.css
    
    extra:
      social:
        - icon: fontawesome/brands/x-twitter 
          link: https://twitter.com/QIMCenter
    
    markdown_extensions:
      - pymdownx.highlight:
          anchor_linenums: true
    
    fima's avatar
    fima committed
          line_spans: __span
          pygments_lang_class: true
      - admonition
      - attr_list
      - md_in_html
    
    fima's avatar
    fima committed
      - tables
    
    fima's avatar
    fima committed
      - pymdownx.inlinehilite
      - pymdownx.snippets
      - pymdownx.details
      - pymdownx.superfences
    
    s184058's avatar
    s184058 committed
      - pymdownx.tabbed:
          alternate_style: true
    
    fima's avatar
    fima committed
      - pymdownx.emoji:
          emoji_index: !!python/name:material.extensions.emoji.twemoji
          emoji_generator: !!python/name:material.extensions.emoji.to_svg
    
    
    plugins: 
        - tags
        - search 
        - mkdocstrings:
            handlers:
              python:
                options:    
                  show_root_heading: true
                  show_source: true
                  show_root_full_path: true
                  show_object_full_path: true
                  show_symbol_type_heading: true
    
    fima's avatar
    fima committed
                  show_symbol_type_toc: false
    
                  separate_signature: true