diffsync/mkdocs.yml at develop · networktocode/diffsync · 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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
---
dev_addr: "127.0.0.1:8001"
edit_uri: "edit/main/diffsync/docs"
site_dir: "diffsync/static/diffsync/docs"
site_name: "DiffSync Documentation"
site_url: "https://diffsync.readthedocs.io/en/latest/"
repo_url: "https://github.com/networktocode/diffsync"
copyright: "Copyright &copy; The Authors"
theme:
  name: "material"
  navigation_depth: 4
  custom_dir: "docs/assets/overrides"
  hljs_languages:
    - "python"
    - "yaml"
  features:
    - "content.action.edit"
    - "content.action.view"
    - "content.code.copy"
    - "navigation.footer"
    - "navigation.indexes"
    - "navigation.tabs"
    - "navigation.tabs.sticky"
    - "navigation.tracking"
    - "search.highlight"
    - "search.share"
    - "search.suggest"
  favicon: "assets/favicon.ico"
  logo: "assets/networktocode_logo.svg"
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: "default"
      primary: "black"
      toggle:
        icon: "material/weather-sunny"
        name: "Switch to dark mode"

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: "slate"
      primary: "black"
      toggle:
        icon: "material/weather-night"
        name: "Switch to light mode"
extra_css:
  - "assets/extra.css"

extra:
  generator: false
  ntc_sponsor: true
  social:
    - icon: "fontawesome/solid/rss"
      link: "https://blog.networktocode.com/"
      name: "Network to Code Blog"
    - icon: "fontawesome/brands/youtube"
      link: "https://www.youtube.com/channel/UCwBh-dDdoqzxXKyvTw3BuTw"
      name: "Network to Code Videos"
    - icon: "fontawesome/brands/slack"
      link: "https://www.networktocode.com/community/"
      name: "Network to Code Community"
    - icon: "fontawesome/brands/github"
      link: "https://github.com/networktocode/"
      name: "GitHub Organization"
    - icon: "fontawesome/brands/twitter"
      link: "https://twitter.com/networktocode"
      name: "Network to Code Twitter"
markdown_extensions:
  - "markdown_version_annotations":
      admonition_tag: "???"
  - "admonition"
  - "toc":
      permalink: true
  - "attr_list"
  - "md_in_html"
  - "markdown_data_tables":
      base_path: "docs"
  - "pymdownx.details"
  # Need pymdownx.emoji for Grid icon search
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - "pymdownx.highlight":
      anchor_linenums: true
  - "pymdownx.inlinehilite"
  - "pymdownx.snippets"
  - "pymdownx.superfences":
      custom_fences:
        - name: "mermaid"
          class: "mermaid"
          format: !!python/name:pymdownx.superfences.fence_code_format
  - "pymdownx.tabbed":
      "alternate_style": true
  - "pymdownx.tilde"

plugins:
  - "search"
  - "gen-files":
      scripts:
        - "docs/generate_code_reference_pages.py"
  - "glightbox":
      manual: true # See https://blueswen.github.io/mkdocs-glightbox/flexibility/enable-by-image-or-page/
  - "section-index"
  - "mkdocstrings":
      default_handler: "python"
      handlers:
        python:
          paths: ["."]
          options:
            heading_level: 1
            show_root_heading: true
            show_root_members_full_path: true
            show_source: false

validation:
  absolute_links: "warn"
  anchors: "warn"
  omitted_files: "warn"
  unrecognized_links: "warn"

nav:
  - Overview: "index.md"
  - User Guide:
      - Library Overview: "user/lib_overview.md"
      - Getting Started: "user/lib_getting_started.md"
      - Using the Library: "user/lib_use_cases.md"
      - Frequently Asked Questions: "user/faq.md"
  - Administrator Guide:
      - Install and Configure: "admin/install.md"
      - Upgrade: "admin/upgrade.md"
      - Uninstall: "admin/uninstall.md"
      - Release Notes:
          - "admin/release_notes/index.md"
          - v1.0: "admin/release_notes/version_1.0.md"
          - v1.1: "admin/release_notes/version_1.1.md"
          - v1.2: "admin/release_notes/version_1.2.md"
          - v1.3: "admin/release_notes/version_1.3.md"
          - v1.4: "admin/release_notes/version_1.4.md"
          - v1.5: "admin/release_notes/version_1.5.md"
          - v1.6: "admin/release_notes/version_1.6.md"
          - v1.7: "admin/release_notes/version_1.7.md"
          - v1.8: "admin/release_notes/version_1.8.md"
          - v1.9: "admin/release_notes/version_1.9.md"
          - v1.10: "admin/release_notes/version_1.10.md"
          - v2.0: "admin/release_notes/version_2.0.md"
          - v2.1: "admin/release_notes/version_2.1.md"
          - v2.2: "admin/release_notes/version_2.2.md"
  - Developer Guide:
      - Extending the Library: "dev/extending.md"
      - Contributing to the Library: "dev/contributing.md"
      - Development Environment: "dev/dev_environment.md"
      - Release Checklist: "dev/release_checklist.md"
      - Architecture Design Records: "dev/arch_decision.md"
  - User Guide:
      - Flags: "source/core_engine/01-flags.md"
      - Customize Diff Class: "source/core_engine/02-customize-diff-class.md"
      - Store: "source/core_engine/03-store.md"
      - Getting Started: "source/getting_started/01-getting-started.md"
      - Upgrading: "source/upgrading/01-upgrading-to-2.0.md"
  - Code Reference:
      - diffsync: "code-reference/diffsync/__init__.md"
      - diff: "code-reference/diffsync/diff.md"
      - enum: "code-reference/diffsync/enum.md"
      - exceptions: "code-reference/diffsync/exceptions.md"
      - helpers: "code-reference/diffsync/helpers.md"
      - log: "code-reference/diffsync/log.md"
      - logging: "code-reference/diffsync/logging.md"
      - utils: "code-reference/diffsync/utils.md"
      - store: "code-reference/diffsync/store/__init__.md"
      - local: "code-reference/diffsync/store/local.md"
      - redis: "code-reference/diffsync/store/redis.md"