CodeSecTools/mkdocs.yml at main · OPPIDA/CodeSecTools · 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
site_name: CodeSecTools
site_author: nolliv22
repo_url: https://github.com/OPPIDA/CodeSecTools
repo_name: OPPIDA/CodeSecTools

nav:
  - Home:
    - index.md
    - home/quick_start_guide.md
  - SAST:
    - sast/index.md
    - Supported SAST Tools:
      - sast/supported/index.md
      - sast/supported/*.j2.md
  - Dataset:
    - dataset/index.md
    - Supported datasets:
      - dataset/supported/index.md
      - dataset/supported/*.j2.md
  - CLI: cli.md
  - API Reference:
    - api/index.md
    - SAST Tools: api/sast.md
    - All SAST: api/allsast.md
    - Datasets: api/dataset.md
    - Shared: api/shared.md

theme:
  name: material
  language: en
  logo: assets/logo.svg
  favicon: assets/logo.svg
  font:
    text: Noto Sans
  icon:
    repo: fontawesome/brands/github

  features:
    - content.code.copy
    - navigation.expand
    - navigation.instant
    - navigation.instant.progress
    - navigation.indexes
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.prune
    - toc.follow
    - navigation.top
    - search.suggest
    - search.highlight

  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - offline
  - privacy
  - search
  - mermaid2
  - gh-admonitions
  - termynal
  - open-in-new-tab
  - gen-files:
      scripts:
        - docs/gen_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - include-markdown:
      rewrite_relative_urls: true
      start: <!--start-include-->
      end: <!--end-include-->
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          inventories:
            - https://docs.python.org/3/objects.inv
          options:
            find_stubs_package: true
            show_bases: true
            show_source: false
            show_if_no_docstring: true
            members_order: source

            parameter_headings: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            summary:
              attributes: true
              functions: true
              modules: true

            merge_init_into_class: true
            docstring_style: google

            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            relative_crossrefs: true
            scoped_crossrefs: true
            annotations_path: source

markdown_extensions:
  - attr_list
  - mkdocs-click
  - 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
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - tables

extra_css:
  - assets/extra.css