diameter/mkdocs.yml at master · carstenbock/diameter · 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
site_name: Python Diameter Stack
repo_url: https://github.com/mensonen/diameter
theme:
  name: "material"
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.indexes
    - toc.integrate
  custom_dir: overrides
nav:
  - Home: index.md
  - Installation: setup.md
  - User Guide:
    - guide/index.md
    - Working with AVPs: guide/avp.md
    - Working with messages: guide/message.md
    - Connecting to peers: guide/node.md
    - Application basics: guide/application.md
    - Sample application: guide/sample_application.md
    - Statistics: guide/node_statistics.md
    - Extending and customising: guide/extending_the_stack.md
  - Examples:
    - Credit Control SMS client: examples/credit_control_sms_client.md
    - Idling server and client: examples/idle_server_client.md
  - API Refrence:
    - AVP:
      - api/avp/index.md
      - Grouped AVPs: api/avp/grouped.md
    - Message: api/message.md
    - Commands:
      - AA: api/commands/aa.md
      - AA Mobile Node: api/commands/aa_mobile_node.md
      - Abort Session: api/commands/abort_session.md
      - Accounting: api/commands/accounting.md
      - Capabilities Exchange: api/commands/capabilities_exchange.md
      - Credit Control: api/commands/credit_control.md
      - Device Watchdog: api/commands/device_watchdog.md
      - Diameter EAP: api/commands/diameter_eap.md
      - Disconnect Peer: api/commands/disconnect_peer.md
      - Home Agent MIP: api/commands/home_agent_mip.md
      - Location Info: api/commands/location_info.md
      - Multimedia Auth: api/commands/multimedia_auth.md
      - Push Profile: api/commands/push_profile.md
      - Re Auth: api/commands/re_auth.md
      - Registration Termination: api/commands/registration_termination.md
      - Server Assignment: api/commands/server_assignment.md
      - Session Termination: api/commands/session_termination.md
      - Spending Limit: api/commands/spending_limit.md
      - Spending Status Notification: api/commands/spending_status_notification.md
      - User Authorization: api/commands/user_authorization.md
      - Other: api/commands/other_commands.md
    - Node: api/node.md
    - Peer: api/peer.md
    - Application: api/application.md
    - Node utilities: api/utilities.md
plugins:
  - search
  - autorefs
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            docstring_style: google
            show_source: false
            separate_signature: true
            show_signature_annotations: true
            line_length: 70
            signature_crossrefs: true
watch:
  - src
markdown_extensions:
  - def_list
  - pymdownx.highlight:
      guess_lang: true
      stripnl: false
      line_spans: __span
  - pymdownx.superfences
  - pymdownx.snippets
  - admonition
  - toc:
      permalink: true