arcticsecurity-python/mkdocs.yml at main · arcticsecurity/arcticsecurity-python · 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
---
site_name: Arctic Security
site_description: Documentation for Arctic Security Python library
site_url: https://github.com/abusesa/arcticsecurity-python

theme:
  name: material
  features:
    - navigation.instant
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            # Options from example generated by AI
            docstring_style: google
            show_root_heading: true
            show_source: true

            # The following options copied from
            # https://mkdocstrings.github.io/python/usage/#recommended-settings
            # (disabled some here by expirementing)
            docstring_options:
              ignore_init_summary: true
            # docstring_section_style: list
            # filters: public  # Sponsors only!
            # summary: true  # Adds Methods-table
            # heading_level: 1
            # parameter_headings: true
            type_parameter_headings: true
            # show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            line_length: 80  # controls function signatures in docs
            merge_init_into_class: true
            separate_signature: true
            show_signature_annotations: true
            show_signature_type_parameters: true

repo_name: abusesa/arcticsecurity-python
repo_url: https://github.com/abusesa/arcticsecurity-python
edit_uri: ""

nav:
  - Home: index.md
  - Sync: sync.md
  - Query: query.md
  - API Reference: api.md