SDS-Framework/mkdocs.yml at main · ARM-software/SDS-Framework · 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
site_name: SDS-Framework
extra:
  version: 2.1.0
repo_url: https://github.com/ARM-software/SDS-Framework
edit_uri: ./edit/main/documentation
nav:
    - Home: index.md
    - Overview: overview.md
    - SDS Template Application: template.md
    - SDSIO Interface: sdsio.md
    - Utilities: utilities.md
    - Theory of Operation: theory.md
    - API Modules: SDS_API/modules.md

plugins:
    - search
    - mermaid2    # pip install mkdocs-mermaid2-plugin
    - mkdoxy:     # pip install mkdoxy
        projects:
          SDS_API:
            src-dirs: ./sds/include
            full-doc: true
            doxy-cfg:
              FILE_PATTERNS: "*.h *.txt"
              CASE_SENSE_NAMES: YES     # Ensure case is preserved in output names
              FILE_NAME_CASE: PRESERVE  # Newer option; PRESERVE keeps case, LOWER changes all to lowercase

theme:
  name: readthedocs
markdown_extensions:
  - admonition
extra_css:
  - css/extra.css
docs_dir: documentation
site_dir: docs
use_directory_urls: false