certmonitor/mkdocs.yml at develop · bradh11/certmonitor · 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
site_name: CertMonitor Documentation
site_description: Documentation for the CertMonitor library
site_author: Brad Haas
site_url: https://certmonitor.readthedocs.io/
repo_url: https://github.com/bradh11/certmonitor
repo_name: bradh11/certmonitor
nav:
  - Home: index.md
  - Usage:
      - Overview: usage/index.md
      - Installation: usage/installation.md
      - Basic Usage: usage/basic.md
      - Using IP Addresses: usage/ip.md
      - Context Manager vs Manual Close: usage/context_manager.md
      - Certificate Validators: usage/validators.md
      - Passing Arguments to Validators: usage/validator_args.md
      - Retrieving Raw Certificate Data: usage/raw_cert.md
      - Retrieving Cipher Information: usage/cipher.md
      - Error Handling: usage/error_handling.md
      - Full Workflow Example: usage/full_workflow.md
      - Environment Variable Configuration: usage/env.md
      - Protocol Detection: usage/protocol.md
      - Troubleshooting: usage/troubleshooting.md
      - Performance Tips: usage/performance.md
      - FAQ: usage/faq.md
  - Validators:
      - Overview: validators/index.md
      - Expiration: validators/expiration.md
      - Hostname: validators/hostname.md
      - SubjectAltNames: validators/subject_alt_names.md
      - RootCertificate: validators/root_certificate.md
      - KeyInfo: validators/key_info.md
      - TLSVersion: validators/tls_version.md
      - WeakCipher: validators/weak_cipher.md
      - SensitiveDate: validators/sensitive_date.md
      - Chain: validators/chain.md
  - API Reference:
      - CertMonitor: reference/certmonitor.md
      - Validators: reference/validators.md
      - Utils: reference/utils.md
      - Protocol Handlers: reference/protocol_handlers.md
      - Error Handlers: reference/error_handlers.md
      - Cipher Algorithms: reference/cipher_algorithms.md
  - Development: development.md

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.annotate
  palette:
    - scheme: default
      primary: blue
      accent: light blue
    - scheme: slate
      primary: blue
      accent: light blue
  font:
    text: Roboto
    code: Roboto Mono
  logo: images/logo.svg
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            docstring_style: google
            merge_init_into_class: true
            show_root_heading: true
            show_signature_annotations: true
            separate_signature: true
            show_if_no_docstring: true
            extra:
              show_docstring_examples: true
              show_docstring_parameters: true
              show_docstring_return: true
              show_docstring_raises: true
markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - pymdownx.tabbed:
      alternate_style: true
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/yourusername/certmonitor