flatline/mkdocs.yml at main · patacca/flatline · 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
site_name: flatline
site_description: Python wrapper around the Ghidra decompiler
repo_url: https://github.com/patacca/flatline
repo_name: patacca/flatline
docs_dir: docs-site

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
  features:
    - navigation.sections
    - navigation.expand
    - navigation.tabs
    - navigation.indexes
    - toc.follow
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            members_order: source
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true

extra:
  version:
    provider: mike

nav:
  - Home: index.md
  - Installation: installation.md
  - Getting Started: getting-started.md
  - X-Ray:
    - xray/index.md
    - Tutorial: xray/tutorial.md
  - How-to Guides:
    - how-to/index.md
    - Load from Binary: how-to/load-from-binary.md
    - Enumerate Languages: how-to/enumerate-languages.md
    - Session Management: how-to/session-management.md
    - Handle Errors: how-to/handle-errors.md
    - Analysis Budget: how-to/analysis-budget.md
    - Enriched Output: how-to/enriched-output.md
  - API Reference:
    - reference/index.md
    - Session: reference/session.md
    - Request & Result: reference/request-result.md
    - Data Models: reference/models.md
    - Enriched Output: reference/enriched.md
    - Constants: reference/constants.md
    - Errors: reference/errors.md
  - Explanation:
    - Architecture: explanation/architecture.md
    - ISA Support: explanation/isa-support.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - toc:
      permalink: true