armis-sdk-python/mkdocs.yml at master · ArmisSecurity/armis-sdk-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
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
site_name: Armis Python SDK
site_url: !ENV READTHEDOCS_CANONICAL_URL
repo_url: https://github.com/ArmisSecurity/armis-sdk-python

nav:
  - Getting started: index.md
  - Entities:
      - Asset:
          - entities/asset/index.md
          - Device:
            - entities/asset/device/index.md
            - entities/asset/device/Boundary.md
            - entities/asset/device/NetworkInterface.md
      - DataExport:
        - entities/data_export/index.md
        - Application: entities/data_export/Application.md
        - RiskFactor: entities/data_export/RiskFactor.md
        - Vulnerability: entities/data_export/Vulnerability.md
      - CollectorImage:
          - entities/collector_image/index.md
          - entities/collector_image/CollectorImageType.md
      - DeviceCustomProperty: entities/DeviceCustomProperty.md
      - Site:
        - entities/site/index.md
        - entities/site/AsqRule.md
  - Clients:
      - AssetsClient:
        - clients/assets_client/index.md
        - clients/assets_client/AssetIdSource.md
      - CollectorsClient:
          - clients/collectors_client/index.md
          - clients/collectors_client/DownloadProgress.md
      - DataExportClient: clients/DataExportClient.md
      - DeviceCustomPropertiesClient: clients/DeviceCustomPropertiesClient.md
      - SitesClient: clients/SitesClient.md
  - Core:
      - ArmisClient: core/ArmisClient.md
      - ArmisSdk: core/ArmisSdk.md
      - Errors: core/errors.md
  - About Armis: about.md

theme:
  name: material
  favicon: images/favicon.png
  logo: images/logo.png
  palette:
    primary: custom
  features:
    - content.code.annotate
    - content.code.copy
    - navigation.indexes

plugins:
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [ . ]
          options:
            members_order: source
            show_bases: true
            show_source: false
            show_root_heading: true
            summary: true
  - search

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

extra:
  analytics:
    provider: google
    property: G-RNCS8V9TDB

extra_css:
  - stylesheets/extra.css

extra_javascript:
    - javascript/readthedocs.js