This repository has been archived by the owner on Aug 4, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
114 lines (101 loc) · 2.67 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
site_name: InJobBot
repo_url: https://github.com/hossam-elshabory/InJobBot
repo_name: hossam-elshabory/InJobBot
nav:
- InJobBot: index.md
- Tutorial - User Guide:
- 01_Tutorial - User Guide/01_creating_bot_token.md
- 01_Tutorial - User Guide/02_cloning_repo.md
- 01_Tutorial - User Guide/03_configuring_bot.md
- 01_Tutorial - User Guide/04_running_bot.md
- Bot's Commands:
- 02_Bot_Commands/01_commands.md
- 02_Bot_Commands/02_job_command.md
- 02_Bot_Commands/03_allow_list_commands.md
- 02_Bot_Commands/04_help_and_tips_commands.md
- Bot Database Design:
- 03_Database_Design/01_database_design.md
# Theme settings
theme:
name: material
logo: assets/index/website_logo.png
favicon: assets/index/project_logo.png
custom_dir: docs/overrides
features:
- navigation.expand
- navigation.instant
- navigation.tracking
- navigation.top
- toc.follow
- search.suggest
- search.highlight
- content.tabs.link
- header.autohide
- announce.dismiss
palette:
scheme: slate
primary: blue
accent: green
icon:
repo: fontawesome/brands/github
# plugins
plugins:
- search
- autolinks
- mkdocstrings:
custom_templates: templates
default_handler: python
handlers:
python:
options:
# heading settings
heading_level: 0
# docstring settings
docstring_section_style: "table"
docstring_style: "numpy"
# annotations settings
show_signature_annotations: True
# path and table of content settings
show_root_full_path: False
show_root_toc_entry: False
# CSS styling
extra_css:
- stylesheets/extra.css
# Extra
extra:
version:
provider: mike
# Markdown extensions
markdown_extensions:
# Python Markdown
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
# Python Markdown Extensions
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.critic
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
copyright: Copyright © 2023 Hossam Elshabory.