-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
128 lines (120 loc) · 3.01 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
---
# Project Information
site_name: "PyBWE"
site_url: "https://nicoudart.github.io/PyBWE"
site_author: "Nicolas OUDART"
site_description: "Python tools for Bandwidth Extrapolation of radar signals"
# Repository information
repo_name: "NicOudart/PyBWE"
repo_url: "https://github.com/NicOudart/PyBWE"
edit_uri: "edit/main/docs/"
# Copyright
copyright: Copyright © 2023 Nicolas OUDART
# Configuration
theme:
name: material
icon:
repo: fontawesome/brands/github
view: material/eye
logo: Logo_PyBWE.svg
favicon: Logo_PyBWE.ico
palette:
- scheme: default
toggle:
icon: material/brightness-7
name: Dark mode
primary: blue
accent: yellow
- scheme: slate
toggle:
icon: material/brightness-4
name: Light mode
primary: blue
accent: yellow
features:
- navigation.instant
- navigation.indexes
- toc.integrate
- toc.follow
- content.code.copy
- content.code.annotate
language: en
plugins:
- search
- gen-files:
scripts:
- docs/gen_api_pages.py
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [PyBWE]
options:
docstring_style: numpy
docstring_section_style: table
docstring_options:
ignore_init_summary: true
merge_init_into_class: true
show_object_full_path: true
members_order: alphabetical
- literate-nav:
nav_file: SUMMARY.md
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
use_pygments: true
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets:
auto_append:
- docs/abbreviations.md
- pymdownx.superfences
- footnotes
- attr_list
- md_in_html
- def_list
- admonition
- pymdownx.details
- pymdownx.tabbed:
alternate_style: true
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.smartsymbols
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
# Abbreviations
- abbr
# Footer
extra:
#history_buttons: false
version: v2.4
#nav_links:
social:
- icon: fontawesome/brands/github
link: https://github.com/NicOudart
name: Nicolas OUDART on GitHub
- icon: fontawesome/brands/researchgate
link: https://www.researchgate.net/profile/Nicolas-Oudart
name: Nicolas OUDART on ResearchGate
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/in/nicolas-oudart-683aab109/
name: Nicolas OUDART on LinkedIn
# Page tree
nav:
- Home: index.md
- Installation: installation.md
- User Guide:
- PyBWE: PyBWE.md
- PyPBWE: PyPBWE.md
- PySSBWE: PySSBWE.md
- Tests:
- Unit and integration tests: unit_integration_tests.md
- Performance tests: performance_tests.md
- Community guidelines: community.md
- References: references.md
- Credits: credits.md