-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathmkdocs.yml
118 lines (114 loc) · 3.24 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
site_name: Hexital
site_url: https://MerlinR.github.io/Hexital
repo_name: merlinr/hexital
repo_url: https://github.com/MerlinR/Hexital
site_author: Merlinr
edit_uri: blob/master/docs/
site_description: Hexital - Incremental Technical Analysis Library
copyright: Copyright © 2024 Merlinr
theme:
name: material
icon:
logo: material/hexagon-outline
palette:
# Palette toggle for light mode
- scheme: default
toggle:
icon: material/weather-night
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to light mode
primary: yellow
accent: white
features:
- navigation.tabs
- navigation.footer
markdown_extensions:
- abbr
- attr_list
- def_list
- tables
- admonition
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets:
auto_append: ["../LICENSE", "../CHANGELOG.md"]
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.details
plugins:
- search
- link-marker
- section-index
- git-revision-date-localized
- gen-files:
scripts:
- docs/scripts/gen_ref_pages.py
- literate-nav:
nav_file: SUMMARY.md
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
paths: [ src ]
options:
line_length: 80
docstring_options:
ignore_init_summary: true
docstring_section_style: table
show_if_no_docstring: false
filters: [ "!^_" ]
heading_level: 2
inherited_members: true
merge_init_into_class: true
separate_signature: true
show_docstring_modules: true
modernize_annotations: true
show_root_heading: true
show_root_full_path: false
show_signature_annotations: true
show_symbol_type_heading: true
show_symbol_type_toc: true
signature_crossrefs: true
summary: true
extra:
version:
provider: mike
nav:
- Hexital: index.md
- Features: features.md
- Guides:
- Quick Start: guides/quick-start.md
- Indicators: guides/indicators-indepth.md
- Candles: guides/candles.md
- Hexital Strategy: guides/hexital-indepth.md
- Indicator Analysis: guides/analysis-indepth.md
- Candlesticks: guides/candlesticks.md
# - Amorph Indicator: guides/amorph.md
- Creating Indicator: guides/custom-indicator.md
- Indicator's: indicator-catalogue.md
- Catalogues:
- Indicator's: indicator-catalogue.md
- Candle Pattern's: candle-pattern-catalogue.md
- Candlestick's - Beta: candlesticks-catalogue.md
- Analysis Functions: analysis-catalogue.md
- API Reference:
- Reference: reference/index.md
- API: reference/
- About:
- Design and Future: about/design.md
- Alternatives: about/alternatives.md
- Issue Tracker: https://github.com/MerlinR/Hexital/issues
- Release Notes: changelog.md