-
-
Notifications
You must be signed in to change notification settings - Fork 55
/
mkdocs.yml
115 lines (104 loc) · 3.14 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
site_name: QuickOSM
site_author: 3Liz
site_description: Download OSM data within QGIS with the Overpass
site_url: https://docs.3liz.org/QuickOSM/
repo_url: https://github.com/3liz/QuickOSM
copyright: '<span class="copyleft">©</span> 3Liz'
docs_dir: docs
site_dir: build
nav:
- docs.3liz.org: '../'
- Home: index.md
- User guide:
- 'End user': 'user-guide/end-user.md'
- 'Map preset': 'user-guide/map-preset.md'
- 'QGIS Model and Python API': 'user-guide/processing.md'
- Processing: processing/README.md
- Documentation:
# - 'Developer documentation': 'code-documentation/developer.md'
- 'Definition files': 'code-documentation/definitions.md'
- 'Processing files': 'code-documentation/processing.md'
- 'Core files': 'code-documentation/core.md'
- 'Ui files': 'code-documentation/ui.md'
- 'Tests files': 'code-documentation/tests.md'
- Changelog: changelog.md
- Contributing: contributing.md
- Translation: translation-stats.md
- References: references.md
plugins:
- search
- git-revision-date-localized
# - mkdocstrings:
# default-handler: python
# handlers:
# python:
## setup_commands:
## - import sys
## - sys.path.append('QuickOSM/QuickOSM')
# selection:
# filters:
# - "!^doc_processing.py"
# docstring_style: restructured-text
# rendering:
# show_root_heading: true
# show_source: false
# show_signature_annotations: true
# watch:
# - QuickOSM
markdown_extensions:
- admonition:
- attr_list:
- meta:
- pymdownx.details:
- pymdownx.highlight:
linenums: true
linenums_style: pymdownx.inline
- pymdownx.keys:
- pymdownx.magiclink:
- pymdownx.progressbar:
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_div_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
- pymdownx.snippets:
- toc:
permalink: "#"
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js
- https://unpkg.com/mermaid@8.6.4/dist/mermaid.min.js
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/default.min.css
- media/code.css
- media/progress_bar.css
theme:
name: material
font: false
icon:
repo: fontawesome/brands/github-alt
language: 'en'
logo: media/icon.png
favicon: media/icon.png
palette:
accent: deep-orange
primary: green
scheme: preference
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/3LIZ_news
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/3liz
- icon: fontawesome/brands/github
link: https://github.com/3liz/
- icon: fontawesome/brands/docker
link: https://hub.docker.com/u/3liz
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/channel/UCYYW2CTWR_84kB6pt2zCWbQ