-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
124 lines (109 loc) · 2.97 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
119
120
121
122
123
124
# Project main info
site_name: cloudgeass
site_url: https://cloudgeass.readthedocs.io/en/latest/
site_author: Thiago Panini
site_description: >-
A Python package that uses boto3's clients and resources
to delivery useful functions to operate with AWS services
# Source repo info
repo_name: ThiagoPanini/cloudgeass
repo_url: https://github.com/ThiagoPanini/cloudgeass
# Copyright
copyright: |
Copyright © 2023 <a href="https://github.com/ThiagoPanini" target="_blank" rel="noopener">ThiagoPanini</a>
# Setting up docs dir
docs_dir: docs/mkdocs
# Setting up theme
theme:
name: material
# Pointing a additional dir for custom setup
custom_dir: docs/assets
# Setting up a custom icon for site header
icon:
logo: custom/custom-icon
# Setting up a color palette
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
accent: white
toggle:
icon: material/weather-sunny
name: Tap for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: black
toggle:
icon: material/weather-night
name: Tap for light mode
# Setting up template features
features:
- navigation.tabs
- navigation.top
- navigation.instant
- navigation.footer
- navigation.indexes
- content.tabs.link
- content.tooltips
- search.share
- search.highlight
- search.suggest
- content.code.copy
# Setting up navigation
nav:
- Home:
- cloudgeass: index.md
- A draw.io view: architecture.md
- Library structure: library-structure.md
- Design and colors: design.md
- Documentation:
- S3: mkdocstrings/s3.md
- EC2: mkdocstrings/ec2.md
- Secrets Manager: mkdocstrings/secrets.md
- Demos:
- About demos: demos/about-demos.md
- S3 module demos:
- list_buckets(): demos/s3/list_buckets.md
- bucket_objects_report(): demos/s3/bucket_objects_report.md
- get_last_date_partition(): demos/s3/get_last_date_partition.md
- EC2 module demos:
- get_default_vpc_id(): demos/ec2/get_default_vpc_id.md
- Secrets Manager module demos:
- get_secret_string(): demos/secrets/get_secret_string.md
- Contributing: contributing/contributing.md
- FAQ: faq/faq.md
# Setting up MkDocs extensions
markdown_extensions:
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.emoji
- pymdownx.mark
- pymdownx.tilde
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.details
- footnotes
- markdown.extensions.tables
- markdown.extensions.footnotes
- attr_list
- toc:
permalink: true
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- attr_list
- md_in_html
# Custom CSS
extra_css:
- stylesheets/extra.css
# Plugins
plugins:
- search:
lang: en
- mkdocstrings
- drawio_file
- glightbox