Skip to content
Snippets Groups Projects
mkdocs.yml 1.16 KiB
Newer Older
Frederik Hennig's avatar
Frederik Hennig committed
site_name: pystencils Source File Generator Documentation
theme: 
  name: material
  features: 
    - navigation.tabs
    - content.code.copy
  palette:
    scheme: slate
    primary: deep purple

extra_css:
 - css/mkdocstrings.css
Frederik Hennig's avatar
Frederik Hennig committed

plugins:
  - search
  - autorefs
Frederik Hennig's avatar
Frederik Hennig committed
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            heading_level: 2
            show_root_heading: True
            show_root_full_path: False
            show_symbol_type_heading: True
            show_symbol_type_toc: True
            show_source: False
            show_signature_annotations: True
            signature_crossrefs: True
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences 
Frederik Hennig's avatar
Frederik Hennig committed

nav:
  - Home: index.md
  - 'User Guides':
    - 'Overview': usage/index.md
    - 'Writing Generator Scripts': usage/generator_scripts.md
    - 'In-Depth: Building Source Files': usage/building.md
    - 'CLI and Build System Integration': usage/cli.md
  - 'API Documentation':
    - 'Overview': api/index.md
    - 'Source File Generator Front-End': api/frontend.md
    - 'Kernel Call Tree': api/tree.md