-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
119 lines (118 loc) · 3.32 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
site_name: EasyFinemap
site_url: https://Jianhua-Wang.github.io/easyfinemap
repo_url: https://github.com/Jianhua-Wang/easyfinemap
repo_name: Jianhua-Wang/easyfinemap
watch: [README.md, CONTRIBUTING.md, CHANGELOG.md, easyfinemap]
#strict: true
nav:
- Home:
- Introduction: index.md
- Install: installation.md
- Quick start: quickstart.md
- Usage:
- File formats: fileformats.md
- Validate LD reference: validate.md
- Identify independent loci: identify.md
- Fine-mapping: fine.md
- API:
- EasyFinemap: api/easyfinemap.md
# - CLI: api/cli.md
- LDRef: api/LDRef.md
- Loci: api/Loci.md
- utils: api/utils.md
- Tools: api/tools.md
# - Contributing: contributing.md
# - Changelog: changelog.md
theme:
name: material
language: en
#logo: assets/logo.png
palette:
scheme: preference
primary: teal
accent: teal
features:
# - navigation.indexes
- navigation.tabs
- navigation.top
- content.code.annotate
- navigation.instant
- navigation.tabs.sticky
markdown_extensions:
- admonition
# - callouts
- pymdownx.details
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist
# - pymdownx.emoji
# # emoji_index: !!python/name:materialx.emoji.twemoji
# # emoji_generator: !!python/name:materialx.emoji.to_svg
# - pymdownx.critic
# - pymdownx.caret
# - pymdownx.mark
# - pymdownx.tilde
# - pymdownx.tabbed
# - attr_list
- pymdownx.arithmatex:
generic: true
# - pymdownx.highlight:
# linenums: false
# - pymdownx.superfences
# - pymdownx.inlinehilite
# - pymdownx.details
- admonition
- toc:
# baselevel: 2
permalink: true
# slugify: !!python/name:pymdownx.slugs.uslugify
- meta
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
- include-markdown
- search:
lang: en
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://installer.readthedocs.io/en/stable/objects.inv # demonstration purpose in the docs
- https://mkdocstrings.github.io/autorefs/objects.inv
options:
docstring_style: numpy
docstring_options:
ignore_init_summary: yes
merge_init_into_class: yes
show_submodules: yes
# watch:
# - easyfinemap
extra:
social:
# - icon: fontawesome/brands/twitter
# # replace with your own tweet link below
# link: https://github.com/waynerv/cookiecutter-pypackage
# name: Tweet
# - icon: fontawesome/brands/facebook
# # replace with your own facebook link below
# link: https://github.com/waynerv/cookiecutter-pypackage
# name: Facebook
# - icon: fontawesome/brands/github
# link: https://github.com/Jianhua-Wang/easyfinemap
# name: Github
# - icon: material/email
# link: "mailto:[email protected]"
# to enable disqus, uncomment the following and put your disqus id below
# disqus: disqus_id
# uncomment the following and put your google tracking id below to enable GA
#google_analytics:
#- UA-xxx
#- auto