-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
118 lines (109 loc) · 3.15 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# mkdocs.yml - Documentation Configuration
# Site Information
site_name: Multi-Arch Github Actions
site_description: Multi-architecture Continuous Integration using Github Actions for arm64 and amd64. Using QEMU, Buildx for Docker Multi-Arch, Custom Actions, and Codecov.
site_author: ibrahimroshdy
# Copyright Information
copyright: Copyright © 2024 Ibrahim Roshdy
# Repository Information
repo_url: https://github.com/ibrahimroshdy/multi-arch-github-actions
repo_name: ir/multi-arch-github-actions
# Edit Button Configuration
edit_uri: ""
# Plugins Configuration
plugins:
- search
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://installer.readthedocs.io/en/stable/objects.inv # demonstration purpose in the docs
- https://mkdocstrings.github.io/autorefs/objects.inv
- https://docs.celeryproject.org/en/stable/objects.inv
paths: [ src ]
options:
# docstring_style: google
docstring_options:
ignore_init_summary: true
# docstring_section_style: list
filters: [ "!^_" ]
heading_level: 4
inherited_members: true
merge_init_into_class: true
separate_signature: true
show_root_heading: true
show_root_full_path: true
show_signature_annotations: true
show_symbol_type_heading: true
show_symbol_type_toc: true
signature_crossrefs: true
summary: true
# Theme Configuration
theme:
name: material
# logo: logo.png
# favicon: logo.png
icon:
repo: fontawesome/brands/github
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
# - content.code.select
# - content.tabs.link
- content.tooltips
# - header.autohide
# - navigation.expand
- navigation.footer
- navigation.indexes
# - navigation.instant
# - navigation.instant.prefetch
# - navigation.instant.progress
# - navigation.prune
- navigation.sections
# - navigation.tabs
# - navigation.tabs.sticky
# - navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
# - toc.integrate
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: green
accent: black
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: green
accent: black
toggle:
icon: material/weather-night
name: Switch to system preference
# Navigation Configuration
nav:
- Index: index.md
- CI Multi Arch GHA: ci_multi_arch.md
# Markdown Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
separator: "_"