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