1  site_name: "Pawamoy Testing"
  2  site_description: "Testing this great template"
  3  site_url: "https://pawamoy.github.io/pawamoy-testing"
  4  repo_url: "https://github.com/pawamoy/pawamoy-testing"
  5  repo_name: "pawamoy/pawamoy-testing"
  6  site_dir: "site"
  7  watch: [mkdocs.yml, README.md, CONTRIBUTING.md, CHANGELOG.md, src/pawamoy_testing]
  8  copyright: Copyright © 2025 Timothee Mazzucotelli
  9  edit_uri: edit/main/docs/
 10  
 11  validation:
 12    omitted_files: warn
 13    absolute_links: warn
 14    unrecognized_links: warn
 15  
 16  nav:
 17  - Home:
 18    - Overview: index.md
 19    - Changelog: changelog.md
 20    - Credits: credits.md
 21    - License: license.md
 22  - API reference: reference/api.md
 23  - Development:
 24    - Contributing: contributing.md
 25    - Code of Conduct: code_of_conduct.md
 26    - Coverage report: coverage.md
 27  - Insiders:
 28    - insiders/index.md
 29    - Getting started:
 30      - Installation: insiders/installation.md
 31      - Changelog: insiders/changelog.md
 32  - Author's website: https://pawamoy.github.io/
 33  
 34  theme:
 35    name: material
 36    custom_dir: docs/.overrides
 37    icon:
 38      logo: material/currency-sign
 39    features:
 40    - announce.dismiss
 41    - content.action.edit
 42    - content.action.view
 43    - content.code.annotate
 44    - content.code.copy
 45    - content.tooltips
 46    - navigation.footer
 47    - navigation.instant.preview
 48    - navigation.path
 49    - navigation.sections
 50    - navigation.tabs
 51    - navigation.tabs.sticky
 52    - navigation.top
 53    - search.highlight
 54    - search.suggest
 55    - toc.follow
 56    palette:
 57    - media: "(prefers-color-scheme)"
 58      toggle:
 59        icon: material/brightness-auto
 60        name: Switch to light mode
 61    - media: "(prefers-color-scheme: light)"
 62      scheme: default
 63      primary: teal
 64      accent: purple
 65      toggle:
 66        icon: material/weather-sunny
 67        name: Switch to dark mode
 68    - media: "(prefers-color-scheme: dark)"
 69      scheme: slate
 70      primary: black
 71      accent: lime
 72      toggle:
 73        icon: material/weather-night
 74        name: Switch to system preference
 75  
 76  extra_css:
 77  - css/material.css
 78  - css/mkdocstrings.css
 79  - css/insiders.css
 80  
 81  extra_javascript:
 82  - js/feedback.js
 83  
 84  markdown_extensions:
 85  - attr_list
 86  - admonition
 87  - callouts
 88  - footnotes
 89  - pymdownx.emoji:
 90      emoji_index: !!python/name:material.extensions.emoji.twemoji
 91      emoji_generator: !!python/name:material.extensions.emoji.to_svg
 92  - pymdownx.magiclink
 93  - pymdownx.snippets:
 94      base_path: [!relative $config_dir]
 95      check_paths: true
 96  - pymdownx.superfences
 97  - pymdownx.tabbed:
 98      alternate_style: true
 99      slugify: !!python/object/apply:pymdownx.slugs.slugify
100        kwds:
101          case: lower
102  - pymdownx.tasklist:
103      custom_checkbox: true
104  - toc:
105      permalink: "¤"
106  
107  plugins:
108  - search
109  - autorefs
110  - markdown-exec
111  - section-index
112  - coverage
113  - mkdocstrings:
114      handlers:
115        python:
116          inventories:
117          - https://docs.python.org/3/objects.inv
118          paths: [src]
119          options:
120            backlinks: tree
121            docstring_options:
122              ignore_init_summary: true
123            docstring_section_style: list
124            filters: ["!^_"]
125            heading_level: 1
126            inherited_members: true
127            merge_init_into_class: true
128            separate_signature: true
129            show_root_heading: true
130            show_root_full_path: false
131            show_signature_annotations: true
132            show_source: false
133            show_symbol_type_heading: true
134            show_symbol_type_toc: true
135            signature_crossrefs: true
136            summary: true
137  - llmstxt:
138      full_output: llms-full.txt
139      sections:
140        Usage:
141        - index.md
142        API:
143        - reference/api.md
144  - git-revision-date-localized:
145      enabled: !ENV [DEPLOY, false]
146      enable_creation_date: true
147      type: timeago
148  - minify:
149      minify_html: !ENV [DEPLOY, false]
150  - group:
151      enabled: !ENV [MATERIAL_INSIDERS, false]
152      plugins:
153      - typeset
154  
155  extra:
156    social:
157    - icon: fontawesome/brands/github
158      link: https://github.com/pawamoy
159    - icon: fontawesome/brands/mastodon
160      link: https://fosstodon.org/@pawamoy
161    - icon: fontawesome/brands/twitter
162      link: https://twitter.com/pawamoy
163    - icon: fontawesome/brands/gitter
164      link: https://gitter.im/pawamoy-testing/community
165    - icon: fontawesome/brands/python
166      link: https://pypi.org/project/pawamoy-testing/
167    analytics:
168      feedback:
169        title: Was this page helpful?
170        ratings:
171          - icon: material/emoticon-happy-outline
172            name: This page was helpful
173            data: 1
174            note: Thanks for your feedback!
175          - icon: material/emoticon-sad-outline
176            name: This page could be improved
177            data: 0
178            note: Let us know how we can improve this page.