-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
86 lines (80 loc) · 2.26 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
site_name: iotoolz
repo_url: https://github.com/e2fyi/iotoolz
strict: false
nav:
- Overview: index.md
- Usage:
- Quickstart: index.md
- Basic Streams: streams.md
- S3 Objects as Streams: s3.md
- Creating your CustomStream: custom_stream.md
- API Reference:
- iotoolz:
- iotoolz.AbcStream: classes/AbcStream.md
- iotoolz.StreamInfo: classes/StreamInfo.md
- iotoolz.FileStream: classes/FileStream.md
- iotoolz.HttpStream: classes/HttpStream.md
- iotoolz.TempStream: classes/TempStream.md
- iotoolz.extensions:
- iotoolz.extensions.s3: classes/S3Stream.md
- iotoolz.extensions.minio: classes/MinioStream.md
- iotoolz.streams:
- iotoolz.streams.Streams: classes/Streams.md
- iotoolz.utils:
- iotoolz.utils: utils.md
- Changelog: changelog.md
theme:
name: material
favicon: assets/favicon.ico
#logo: assets/logo192.png
icon:
logo: fontawesome/brands/python
repo: fontawesome/brands/github
features:
- navigation.instant
- navigation.expand
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/eterna2
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/in/william-teo-56021b16
extra_css:
- stylesheets/extra.css
markdown_extensions:
- admonition
- markdown_include.include
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist
- toc:
permalink: true
# slugify: !!python/name:pymdownx.slugs.uslugify
google_analytics:
- UA-180553388-1
- auto
plugins:
- search
- mkdocstrings:
default_handler: python
handlers:
python:
rendering:
show_source: false
show_if_no_docstring: true
show_root_heading: true
show_category_heading: true
setup_commands:
- import sys
- sys.path.append("docs")
selection:
new_path_syntax: yes
filters:
- "!^_" # exlude all members starting with _
- "^__init__$" # but always include __init__ modules and methods
watch:
- iotoolz/
- git-revision-date-localized:
fallback_to_build_date: true