1  site_name: "docstrings2pep727"
  2  site_description: "Move documentation from docstrings to PEP 727 type annotations."
  3  site_url: "https://pawamoy.github.io/docstrings2pep727"
  4  repo_url: "https://github.com/pawamoy/docstrings2pep727"
  5  repo_name: "pawamoy/docstrings2pep727"
  6  site_dir: "site"
  7  watch: [mkdocs.yml, README.md, CONTRIBUTING.md, CHANGELOG.md, src/docstrings2pep727]
  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    - docstrings2pep727: reference/
 25  - Development:
 26    - Contributing: contributing.md
 27    - Code of Conduct: code_of_conduct.md
 28    - Coverage report: coverage.md
 29  - Author's website: https://pawamoy.github.io/
 30  
 31  theme:
 32    name: material
 33    custom_dir: docs/.overrides
 34    icon:
 35      logo: material/currency-sign
 36    features:
 37    - announce.dismiss
 38    - content.action.edit
 39    - content.action.view
 40    - content.code.annotate
 41    - content.code.copy
 42    - content.tooltips
 43    - navigation.footer
 44    - navigation.indexes
 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  markdown_extensions:
 77  - attr_list
 78  - admonition
 79  - callouts
 80  - footnotes
 81  - pymdownx.emoji:
 82      emoji_index: !!python/name:material.extensions.emoji.twemoji
 83      emoji_generator: !!python/name:material.extensions.emoji.to_svg
 84  - pymdownx.magiclink
 85  - pymdownx.snippets:
 86      base_path: [!relative $config_dir]
 87      check_paths: true
 88  - pymdownx.superfences
 89  - pymdownx.tabbed:
 90      alternate_style: true
 91      slugify: !!python/object/apply:pymdownx.slugs.slugify
 92        kwds:
 93          case: lower
 94  - pymdownx.tasklist:
 95      custom_checkbox: true
 96  - toc:
 97      permalink: "¤"
 98  
 99  plugins:
100  - search
101  - markdown-exec
102  - gen-files:
103      scripts:
104      - scripts/gen_ref_nav.py
105  - literate-nav:
106      nav_file: SUMMARY.md
107  - coverage
108  - mkdocstrings:
109      handlers:
110        python:
111          import:
112          - https://docs.python.org/3/objects.inv
113          paths: [src]
114          options:
115            docstring_options:
116              ignore_init_summary: true
117            docstring_section_style: list
118            filters: ["!^_"]
119            heading_level: 1
120            inherited_members: true
121            merge_init_into_class: true
122            separate_signature: true
123            show_root_heading: true
124            show_root_full_path: false
125            show_signature_annotations: true
126            show_symbol_type_heading: true
127            show_symbol_type_toc: true
128            signature_crossrefs: true
129            summary: true
130  - git-committers:
131      enabled: !ENV [DEPLOY, false]
132      repository: pawamoy/docstrings2pep727
133  - minify:
134      minify_html: !ENV [DEPLOY, false]
135  - group:
136      enabled: !ENV [MATERIAL_INSIDERS, false]
137      plugins:
138      - typeset
139  
140  extra:
141    social:
142    - icon: fontawesome/brands/github
143      link: https://github.com/pawamoy
144    - icon: fontawesome/brands/mastodon
145      link: https://fosstodon.org/@pawamoy
146    - icon: fontawesome/brands/twitter
147      link: https://twitter.com/pawamoy
148    - icon: fontawesome/brands/gitter
149      link: https://gitter.im/docstrings2pep727/community
150    - icon: fontawesome/brands/python
151      link: https://pypi.org/project/docstrings2pep727/