This repository has been archived by the owner on Apr 29, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
141 lines (132 loc) · 3.48 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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# Openhiven.py Mkdocs Customisation
site_name: 'openhiven.py Docs'
site_description: 'Documentation for the pypi module openhiven.py'
site_author: 'Luna Klatzer'
site_url: 'https://luna-klatzer.github.io/openhiven.py/'
edit_uri: 'https://github.com/Luna-Klatzer/openhiven.py/edit/main/docs/'
copyright: Copyright © 2020 - 2021 Luna-Klatzer
use_directory_urls: false
nav:
- Home:
- Home: index.md
- home/contributing.md
- home/license.md
- home/troubleshooting.md
- home/bug_reporting.md
- Getting Started:
- getting_started/index.md
- getting_started/deploying_your_first_bot.md
- getting_started/logging.md
- getting_started/event_handling.md
- Setup:
- setup/index.md
- Library Reference:
- reference/hivenclient.md
- reference/http.md
- reference/cache.md
- reference/events.md
- reference/types.md
- reference/hiven_parsers.md
- Hiven API Reference:
- Hiven REST API:
- api_reference/hiven_restapi.md
- api_reference/hiven_request_endpoints.md
- api_reference/hiven_exceptions.md
- Hiven Swarm (WebSocket):
- api_reference/hiven_swarm.md
- api_reference/swarm_events.md
- Hiven Objects:
- api_reference/object_reference.md
- Changelog:
- changelog.md
extra_css:
- assets/css/index.css
# Github repo
repo_url: https://github.com/Luna-Klatzer/openhiven.py
repo_name: Luna-Klatzer/openhiven.py
# Material theme options
theme:
name: material
favicon: ./openhivenpy.ico
shortcuts:
help: 191 # ?
next: 78 # n
previous: 80 # p
search: 83 # s
hljs_languages:
- yaml
- python
palette:
- scheme: slate
primary: deep purple
accent: purple
logo: ./assets/images/openhivenpy.png
icon:
repo: fontawesome/brands/git-alt
features:
- navigation.tabs
- navigation.expand
- navigation.sections
- navigation.instant
# Plugins
plugins:
- git-revision-date
- autorefs
- mkdocstrings: # code-gen
handlers:
python:
selection:
docstring_style: restructured-text
setup_commands:
- import sys
- sys.path.append(".")
- import openhivenpy
rendering:
show_root_heading: true
show_category_heading: true
show_if_no_docstring: true
- search:
lang: en
prebuild_index: true
google_analytics:
- G-WWRJSVTX2V
- auto
# Extensions to the basic mkdocs markdown
markdown_extensions:
- toc:
permalink: true
toc_depth: 4
- pymdownx.tabbed # Nice tabs
- pymdownx.superfences # Very cool embed objects
- pymdownx.critic
- pymdownx.caret
- pymdownx.mark
- pymdownx.details
- pymdownx.highlight
- pymdownx.tilde
- pymdownx.keys
- attr_list # => very cool html and css syntax
- abbr
- pymdownx.snippets # snippet looking sharp!
- admonition
- meta
- admonition # code-gen
- codehilite # code-gen\
- toc
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- docs/.icons
extra:
version:
provider: mike
default: latest
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/FloofyLunafox
name: The author on Twitter
- icon: fontawesome/brands/github
link: https://github.com/Luna-Klatzer/
name: The author and manager of the project