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