-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
162 lines (155 loc) · 4.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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
site_name: Virtual Secretary Documentation
repo_url: https://github.com/aurelienpierreeng/VirtualSecretary
repo_name: aurelienpierreeng/VirtualSecretary
edit_uri: blob/main/docs/
copyright: Copyright © 2022-2023 Aurélien PIERRE
nav:
- Home: index.md
- Getting started:
- starting/index.md
- Install: starting/1-install.md
- Configure: starting/2-configure.md
- Run: starting/3-run.md
- Example filters: starting/4-example-filters.md
- Writing custom filters: starting/5-writing-filters.md
- Crawling pages: starting/6-crawling-pages.md
- Filter API:
- Emails: Filter API/emails.md
- CardDAV: Filter API/carddav.md
- Instagram: Filter API/Instagram.md
- Implement your own protocols: Filter API/your-own-protocols.md
- Core package:
- core/index.md
- App main script: core/1-main.md
- Secretary manager: core/2-secretary.md
- Protocols connector: core/3-connectors.md
- Page crawler: core/4-crawler.md
- Natural language processor: core/5-nlp.md
- Regular expressions patterns: core/6-patterns.md
- Utilities: core/7-utils.md
- Background:
- Why ?: background/1-why.md
- Proposed workflow: background/2-Proposed-workflow.md
- Email authentication: background/3-Authentication.md
- Risk analysis: background/4-Risk-analysis.md
theme:
name: material
features:
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
- navigation.expand
- navigation.instant
- navigation.top
- navigation.sections
- navigation.footer
- navigation.indexes
- navigation.tabs
- navigation.tabs.sticky
- navigation.tracking
- search.highlight
- search.suggest
- toc.follow
palette:
scheme: slate
primary: pink
accent: purple
logo: assets/virtualsecretary-inverted.png
extra_css:
- assets/material.css
markdown_extensions:
- attr_list
- md_in_html
- smarty
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.critic
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
- pymdownx.magiclink
- toc:
permalink: "¤"
- admonition
- callouts:
strip_period: no
- footnotes
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist
plugins:
- search
- autorefs
- offline
- mkdocstrings:
enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
default_handler: python
enable_inventory: true
watch:
- src
handlers:
python:
paths: [src]
load_external_modules: true
import:
- https://docs.python.org/3/objects.inv
- https://numpy.org/doc/1.24/objects.inv
- https://www.nltk.org/objects.inv
- https://radimrehurek.com/gensim/objects.inv
- https://scikit-learn.org/stable/objects.inv
- https://www.crummy.com/software/BeautifulSoup/bs4/doc/objects.inv
- https://joblib.readthedocs.io/en/stable/objects.inv
options:
show_root_heading: true
show_root_full_path: false
show_object_full_path: false
show_category_heading: yes
group_by_category: true
docstring_style: google
docstring_options:
ignore_init_summary: no
merge_init_into_class: yes
show_signature: yes
show_signature_annotations: yes
signature_crossrefs: true
show_if_no_docstring: no
show_submodules: no
show_docstring_attributes: true
show_docstring_description: true
show_docstring_examples: true
show_docstring_other_parameters: true
show_docstring_raises: true
separate_signature: yes
line_length: 80
docstring_section_style: spacy
show_source: no
members_order: source
heading_level: 2
annotations_path: source
allow_inspection: true
filters:
- "!^_"