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