pybgpkitstream/mkdocs.yml at main · JustinLoye/pybgpkitstream · 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
site_name: PyBGPKITStream
site_description: A drop-in replacement for PyBGPStream using BGPKIT
site_author: JustinLoye
repo_url: https://github.com/JustinLoye/pybgpkitstream
repo_name: pybgpkitstream

theme:
  name: material
  palette:
    - scheme: slate
      primary: blue
      accent: orange
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
    - scheme: default
      primary: blue
      accent: orange
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

nav:
  - Home: index.md
  - Getting Started: getting_started.md
  - User Guide:
      - Configuration: guide/configuration.md
      - Streaming Data: guide/streaming.md
      - Filtering: guide/filtering.md
      - CLI Tool: guide/cli.md
  - API Reference:
      - Overview: api/overview.md
      - BGPKITStream: api/bgpkitstream.md
      - Configuration: api/configuration.md
      - BGPElement: api/bgpelement.md
      - Parsers: api/parsers.md
  - Performance: performance.md
  - FAQ: faq.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_bases: true
            show_root_heading: true
            heading_level: 2
            show_field_summary: false
            show_docstring_description: true
            members_order: source
            group_by_category: true
            extensions:
              - griffe_pydantic:
                  schema: true
            # show_if_no_docstring: true

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - toc:
      permalink: true
  - tables
  - md_in_html