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