cpp-gl/mkdocs.yml at master · SpectraL519/cpp-gl · 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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
site_name: CPP-GL Documentation
site_description: "General-purpose Template Graph and Hypergraph Library for Modern C++"
repo_url: "https://github.com/SpectraL519/cpp-gl"

nav:
  - Home: index.md
  - GL:
      - Quick Start: gl/quick_start.md
      - Architecture & Basics: gl/architecture.md
      - Topologies: gl/topologies.md
      - Algorithms:
          - Overview: gl/algorithms/overview.md
          - Generic Templates: gl/algorithms/templates.md
          - Concrete Traversals: gl/algorithms/traversal.md
          - Pathfinding: gl/algorithms/pathfinding.md
          - Spanning Trees: gl/algorithms/spanning_trees.md
          - Topological Algorithms: gl/algorithms/topological_algs.md
      - I/O Utility: gl/io.md
      - Advanced Features: gl/advanced.md
      - API Reference:
          - Overview: cpp-gl/group__GL.md
          - Core Components: cpp-gl/group__GL-Core.md
          - Algorithms: cpp-gl/group__GL-Algorithm.md
          - Topologies: cpp-gl/group__GL-Topology.md
          - I/O Utility: cpp-gl/group__GL-IO.md
          - Traits & Concepts: cpp-gl/group__GL-Traits.md
          - Generic Types: cpp-gl/group__GL-Types.md
          - General Utilities: cpp-gl/group__GL-Util.md
  - HGL:
      - Quick Start: hgl/quick_start.md
      - Architecture & Basics: hgl/architecture.md
      - Graph Conversions: hgl/conversions.md
      - Algorithms:
          - Overview: hgl/algorithms/overview.md
          - Generic Templates: hgl/algorithms/templates.md
          - Concrete Traversals: hgl/algorithms/traversal.md
          - Hypergraph Properties: hgl/algorithms/properties.md
      - I/O Utility: hgl/io.md
      - API Reference:
          - Overview: cpp-gl/group__HGL.md
          - Core Components: cpp-gl/group__HGL-Core.md
          - Algorithms: cpp-gl/group__HGL-Algorithm.md
          - I/O Utility: cpp-gl/group__HGL-IO.md
          - Traits & Concepts: cpp-gl/group__HGL-Traits.md
          - Generic Types: cpp-gl/group__HGL-Types.md
          - General Utilities: cpp-gl/group__HGL-Util.md
  - API Index:
      - Modules: cpp-gl/modules.md
      - Classes & Structs: cpp-gl/annotated.md
      - Class Hierarchy: cpp-gl/hierarchy.md
      - Concepts: cpp-gl/concepts.md
      - Files: cpp-gl/files.md
      # TODO: functions, macros, constants
  - License: license.md

theme:
  name: material
  logo: img/cpp-gl-hex.png
  favicon: img/cpp-gl-hex.png
  icon:
    annotation: material/chevron-right-circle
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - content.code.copy
    - content.code.select
    - content.code.annotate
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-5
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-3
        name: Switch to light mode

markdown_extensions:
  - admonition
  - tables
  - md_in_html
  - attr_list
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.snippets:
      base_path: "."
      check_paths: true
  - toc:
      baselevel: 1
      toc_depth: 2

plugins:
  - search
  - exclude-search:
      exclude:
        - "cpp-gl/*_source.md"
  - include-markdown
  - callouts:
      aliases: false
  - mkdoxy:
      projects:
        cpp-gl:
          src-dirs: "include docs/config/groups.dox"
          full-doc: true
          sorting:
            classes: false
          hideparams: true
          doxy-cfg-file: Doxyfile

extra_javascript:
  - scripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra_css:
  - style/logo.css
  - style/theme.css

extra:
  version:
    provider: mike
    default: "latest"