mkdocs.yml

site_name: "Tranqu Server"
repo_url: "https://github.com/oqtopus-team/tranqu-server"

nav:
- Home: index.md
- Usage:
  - Getting started: usage/getting_started.md
  - Interface Specifications: usage/interface_specifications.md
- API reference:
  - tranqu server: reference/
- Developer Guidelines:
  - Development Flow: developer_guidelines/index.md
  - Setup Development Environment: developer_guidelines/setup.md
  - How to Contribute: CONTRIBUTING.md
  - Code of Conduct: CODE_OF_CONDUCT.md
  - Security: SECURITY.md

theme:
  name: material
  palette:
    primary: "indigo"
    accent: "indigo"
  font:
    text: "Roboto"
    code: "Roboto Mono"
  icon:
    repo: fontawesome/brands/github
  features:
  - toc.follow

markdown_extensions:
- pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format
- admonition
- footnotes
- codehilite
- toc:
    permalink: true

plugins:
- search
- gen-files:
    scripts:
    - scripts/gen_ref_nav.py
- literate-nav:
    nav_file: API_reference.md
- mkdocstrings:
    custom_templates: docs/templates
    handlers:
      python:
        paths: [src]
        options:
          docstring_options:
            ignore_init_summary: true
          docstring_section_style: list
          filters: ["!^_"]
          heading_level: 1
          inherited_members: true
          merge_init_into_class: true
          parameter_headings: true
          preload_modules: [mkdocstrings]
          relative_crossrefs: true
          scoped_crossrefs: true
          separate_signature: true
          show_bases: false
          show_inheritance_diagram: true
          show_root_heading: true
          show_root_full_path: false
          show_signature_annotations: true
          show_source: false
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          signature_crossrefs: true
          summary:
            modules: false
            classes: true
            functions: true
            attributes: true
          unwrap_annotated: true
- mkdocs-jupyter

extra_css:
- "https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css"
- "css/custom.css"