cubinterpp/mkdocs.yml at master · swvanbuuren/cubinterpp · 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
site_name: Cubinterpp Documentation
site_url: https://swvanbuuren.github.io/cubinterpp/
repo_url: https://github.com/swvanbuuren/cubinterpp
repo_name: swvanbuuren/cubinterpp

theme:
  name: material
  features:
  - navigation.sections
  - navigation.tabs
  - navigation.indexes
  - content.code.annotate
  - content.code.copy

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_toc_entry: false
  - mkdoxy:
      projects:
        reference:
          src-dirs: include/ src/
          full-doc: True
          doxy-cfg:
            FILE_PATTERNS: "*.cpp *.h*"
            EXAMPLE_PATH: examples
            RECURSIVE: True

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      url_download: true
  - pymdownx.superfences
  - footnotes
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.blocks.caption

extra_javascript:
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Cubinterpp:
    - index.md
    - Introduction: introduction.md
    - Requirements: requirements.md
    - Usage instructions: usage.md
    - Examples: examples.md
  - Mathematical Background:
    - theory/index.md
    - Linear interpolation: theory/linear.md
    - Cubic interpolation: theory/cubic.md
    - Derivatives: theory/derivatives.md
  - Code Reference:
    - reference/index.md
    - Links: reference/links.md
    - Classes:
        - Class List: reference/annotated.md
        - Class Index: reference/classes.md
        - Class Hierarchy: reference/hierarchy.md
        - Class Members: reference/class_members.md
        - Class Member Functions: reference/class_member_functions.md
        - Class Member Variables: reference/class_member_variables.md
        - Class Member Typedefs: reference/class_member_typedefs.md
        - Class Member Enumerations: reference/class_member_enums.md
    - Namespaces:
        - Namespace List: reference/namespaces.md
        - Namespace Members: reference/namespace_members.md
        - Namespace Member Functions: reference/namespace_member_functions.md
        - Namespace Member Variables: reference/namespace_member_variables.md
        - Namespace Member Typedefs: reference/namespace_member_typedefs.md
        - Namespace Member Enumerations: reference/namespace_member_enums.md
    - Functions: reference/functions.md
    - Variables: reference/variables.md
    - Macros: reference/macros.md
    - Files: reference/files.md