uwotm8/mkdocs.yml at main · i-dot-ai/uwotm8 · 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
site_name: uwotm8
repo_url: https://github.com/i-dot-ai/uwotm8
site_url: https://i-dot-ai.github.io/uwotm8
site_description: Converting American English to British English
site_author: Incubator for AI
edit_uri: edit/main/docs/
repo_name: i-dot-ai/uwotm8
copyright: Maintained by <a href="https://ai.gov.uk">i.AI</a>

nav:
  - Home: index.md
  - Usage Guide: usage.md
  - Implementation Details: modules.md
  - Abbreviations: abbreviations.md

theme:
  logo: assets/i-dot-ai-white-invert.svg
  favicon: assets/i-dot-ai.svg

  name: material
  font:
    text: "Inter"
    code: "DM Mono"

  features:
    - content.tooltips
    - search.suggest
    - search.highlight
    - content.tabs.link
    - navigation.indexes
    - content.tooltips
    - navigation.path
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - navigation.tabs

  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/i-dot-ai/uwotm8
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/uwotm8
    - icon: fontawesome/solid/globe
      link: https://ai.gov.uk
  generator: false

plugins:
  minify:
    minify_html: true
  search: null
  mermaid2: null
  git-revision-date-localized:
    type: timeago
    locale: en
    fallback_to_build_date: true
  glightbox: null
  mkdocstrings:
    handlers:
      python:
        options:
          extensions:
            - griffe_typingdoc
          show_root_heading: true
          show_if_no_docstring: true
          inherited_members: true
          members_order: source
          separate_signature: true
          unwrap_annotated: true
          filters:
            - "!^_"
          merge_init_into_class: true
          docstring_section_style: spacy
          signature_crossrefs: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true

markdown_extensions:
  - abbr
  - attr_list
  - meta
  - admonition
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.pathconverter
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - codehilite:
      guess_lang: true
      use_pygments: true
  - pymdownx.tabbed:
      alternate_style: true

extra_css:
  - assets/extra.css