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
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
site_name: CertMonitor
site_description: Zero-dependency Python SSL/TLS certificate monitoring and validation with expiration checks, hostname/SAN matching, X.509 chain analysis, and post-quantum readiness.
site_author: Brad Haas
site_url: !ENV [READTHEDOCS_CANONICAL_URL, "https://certmonitor.readthedocs.io/en/latest/"]
repo_url: https://github.com/bradh11/certmonitor
repo_name: bradh11/certmonitor
nav:
  - Home: index.md
  - Concepts:
      - Overview: concepts/index.md
      - How TLS & HTTPS Work: concepts/how-tls-works.md
      - Certificates & PKI: concepts/certificates-and-pki.md
      - Post-Quantum Cryptography: concepts/post-quantum.md
  - Tutorial & Usage:
      - Overview: usage/index.md
      - Installation: usage/installation.md
      - First Steps: usage/basic.md
      - Command Line: usage/cli.md
      - Using IP Addresses: usage/ip.md
      - Certificates from Files: usage/files.md
      - STARTTLS Services: usage/starttls.md
      - Proxies: usage/proxy.md
      - Detect Changes Between Scans: usage/compare.md
      - Context Manager vs Manual Close: usage/context_manager.md
      - Certificate Validators: usage/validators.md
      - Custom Validators: usage/custom_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
      - Monitoring Integrations: usage/integrations.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
      - Revocation: validators/revocation.md
      - PqKeyExchange: validators/pq_key_exchange.md
      - PqChain: validators/pq_chain.md
      - PqSignature: validators/pq_signature.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:
      - Overview: development.md
      - Contributing a Validator: contributing-a-validator.md
      - Security Configuration: security-configuration.md

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - navigation.tracking
    - toc.follow
    - content.code.copy
    - search.suggest
    - search.highlight
    - content.code.annotate
  palette:
    - scheme: default
      primary: blue
      accent: light blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: light blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  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
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.details
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - pymdownx.tabbed:
      alternate_style: true
extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/bradh11/certmonitor