tgn.cpp/mkdocs.yml at master · Jacob-Chmura/tgn.cpp · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
---
site_name: tgn.cpp Docs
site_url: https://tgn-cpp.readthedocs.io/en/latest/
repo_url: https://github.com/Jacob-Chmura/tgn.cpp

nav:
  - Home: index.md
  - TGUF Specification: tguf-spec.md
  - Python Bindings: python-api.md
  - C++ API:
      - Classes: tgn.cpp/annotated.md
      - Files: tgn.cpp/files.md
      - Namespaces: tgn.cpp/namespaces.md
      - Members: tgn.cpp/class_members.md
      - Macros: tgn.cpp/macros.md
      - Index: tgn.cpp/links.md

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      accent: lime
      primary: black
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.indexes
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest

plugins:
  - search
  - autorefs
  - mkdoxy:
      projects:
        tgn.cpp: # name of project must be alphanumeric + numbers (without spaces)
          src-dirs: ./include # path to source code (support multiple paths separated by space) => INPUT
          full-doc: true # if you want to generate full documentation
          doxy-cfg: # standard doxygen configuration (key: value)
            FILE_PATTERNS: "*.cpp *.h*" # specify file patterns to filter out
            RECURSIVE: true # recursive search in source directories
  - mkdocstrings:
      handlers:
        python:
          paths: [python]
          options:
            show_source: false
            docstring_section_style: list
            show_root_heading: true
            merge_init_into_class: true
            heading_level: 3
            signature_crossrefs: true
            show_signature: true
            show_signature_annotations: true
            annotations_path: "full"