Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
polakowo
GitHub Repository: polakowo/vectorbt
 Path: blob/master/docs/mkdocs.yml
1071 views
1
# Project information

2
site_name: vectorbt

3
site_description: Find your trading edge, using the fastest engine for backtesting, algorithmic trading, and research

4
site_author: Oleg Polakow

5
site_url: https://vectorbt.dev/

6


7
# Repository

8
repo_name: vectorbt

9
repo_url: https://github.com/polakowo/vectorbt

10
edit_uri: ""

11


12
# Copyright

13
copyright: Copyright © 2021 Oleg Polakow. All rights reserved.

14


15
# Configuration

16
theme:

17
  name: material

18
  custom_dir: overrides

19
  include_search_page: false

20
  search_index_only: true

21
  language: en

22
  features:

23
    - navigation.tracking

24
    - navigation.indexes

25
    - navigation.tabs

26
    - navigation.instant

27
    - search.suggest

28
    - search.share

29
  palette:

30
    scheme: default

31
    primary: indigo

32
    accent: blue

33
  icon:

34
    repo: fontawesome/brands/github

35
  font:

36
    text: Roboto

37
    code: Roboto Mono

38
  logo: assets/logo/logo-white.svg

39
  favicon: /assets/logo/favicon.png

40
  sponsor: "https://github.com/sponsors/polakowo"

41


42
# Customization

43
markdown_extensions:

44
  - meta

45
  - admonition

46
  - def_list

47
  - md_in_html

48
  - attr_list

49
  - tables

50
  - footnotes

51
  - toc:

52
      permalink: true

53
  - pymdownx.inlinehilite

54
  - pymdownx.snippets

55
  - pymdownx.superfences

56
  - pymdownx.tabbed:

57
      alternate_style: true

58
  - pymdownx.progressbar

59
  - pymdownx.magiclink:

60
      repo_url_shorthand: true

61
      user: polakowo

62
      repo: vectorbt

63
  - pymdownx.emoji:

64
      emoji_index: !!python/name:material.extensions.emoji.twemoji

65
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

66
  - pymdownx.highlight:

67
      extend_pygments_lang:

68
        - name: pycon3

69
          lang: pycon

70
          options:

71
            python3: true

72
  - pymdownx.tasklist:

73
      custom_checkbox: true

74
extra:

75
  analytics:

76
    provider: google

77
    property: G-4QLCS0J048

78
  social:

79
    - icon: fontawesome/brands/github

80
      link: https://github.com/polakowo

81
extra_javascript:

82
  - assets/javascripts/extra.js

83
extra_css:

84
  - assets/stylesheets/extra.css

85


86
# Plugins

87
plugins:

88
  - search

89
  - minify:

90
      minify_html: true

91


92
# Validation

93
validation:

94
  absolute_links: ignore

95


96
# Page tree

97
nav:

98
  - Getting started:

99
    - index.md

100
    - Features: getting-started/features.md

101
    - Installation: getting-started/installation.md

102
    - Usage: getting-started/usage.md

103
    - Resources: getting-started/resources.md

104
    - Contributing: getting-started/contributing.md

105
  - Documentation: documentation.md

106
  - API:

107
    - api/index.md

108
    - _settings: api/_settings.md

109
    - base:

110
      - api/base/index.md

111
      - accessors: api/base/accessors.md

112
      - array_wrapper: api/base/array_wrapper.md

113
      - column_grouper: api/base/column_grouper.md

114
      - combine_fns: api/base/combine_fns.md

115
      - index_fns: api/base/index_fns.md

116
      - indexing: api/base/indexing.md

117
      - reshape_fns: api/base/reshape_fns.md

118
    - data:

119
      - api/data/index.md

120
      - base: api/data/base.md

121
      - custom: api/data/custom.md

122
      - updater: api/data/updater.md

123
    - generic:

124
      - api/generic/index.md

125
      - accessors: api/generic/accessors.md

126
      - decorators: api/generic/decorators.md

127
      - drawdowns: api/generic/drawdowns.md

128
      - enums: api/generic/enums.md

129
      - nb: api/generic/nb.md

130
      - plots_builder: api/generic/plots_builder.md

131
      - plotting: api/generic/plotting.md

132
      - ranges: api/generic/ranges.md

133
      - splitters: api/generic/splitters.md

134
      - stats_builder: api/generic/stats_builder.md

135
    - indicators:

136
      - api/indicators/index.md

137
      - basic: api/indicators/basic.md

138
      - configs: api/indicators/configs.md

139
      - factory: api/indicators/factory.md

140
      - nb: api/indicators/nb.md

141
    - labels:

142
      - api/labels/index.md

143
      - enums: api/labels/enums.md

144
      - generators: api/labels/generators.md

145
      - nb: api/labels/nb.md

146
    - messaging:

147
      - api/messaging/index.md

148
      - telegram: api/messaging/telegram.md

149
    - ohlcv_accessors: api/ohlcv_accessors.md

150
    - portfolio:

151
      - api/portfolio/index.md

152
      - base: api/portfolio/base.md

153
      - decorators: api/portfolio/decorators.md

154
      - enums: api/portfolio/enums.md

155
      - logs: api/portfolio/logs.md

156
      - nb: api/portfolio/nb.md

157
      - orders: api/portfolio/orders.md

158
      - trades: api/portfolio/trades.md

159
    - px_accessors: api/px_accessors.md

160
    - records:

161
      - api/records/index.md

162
      - base: api/records/base.md

163
      - col_mapper: api/records/col_mapper.md

164
      - decorators: api/records/decorators.md

165
      - mapped_array: api/records/mapped_array.md

166
      - nb: api/records/nb.md

167
    - returns:

168
      - api/returns/index.md

169
      - accessors: api/returns/accessors.md

170
      - metrics: api/returns/metrics.md

171
      - nb: api/returns/nb.md

172
      - qs_adapter: api/returns/qs_adapter.md

173
    - root_accessors: api/root_accessors.md

174
    - signals:

175
      - api/signals/index.md

176
      - accessors: api/signals/accessors.md

177
      - enums: api/signals/enums.md

178
      - factory: api/signals/factory.md

179
      - generators: api/signals/generators.md

180
      - nb: api/signals/nb.md

181
    - utils:

182
      - api/utils/index.md

183
      - array_: api/utils/array_.md

184
      - attr_: api/utils/attr_.md

185
      - checks: api/utils/checks.md

186
      - colors: api/utils/colors.md

187
      - config: api/utils/config.md

188
      - datetime_: api/utils/datetime_.md

189
      - decorators: api/utils/decorators.md

190
      - docs: api/utils/docs.md

191
      - enum_: api/utils/enum_.md

192
      - figure: api/utils/figure.md

193
      - image_: api/utils/image_.md

194
      - mapping: api/utils/mapping.md

195
      - math_: api/utils/math_.md

196
      - module_: api/utils/module_.md

197
      - params: api/utils/params.md

198
      - random_: api/utils/random_.md

199
      - requests_: api/utils/requests_.md

200
      - schedule_: api/utils/schedule_.md

201
      - tags: api/utils/tags.md

202
      - template: api/utils/template.md

203
  - Terms:

204
    - terms/index.md

205
    - License: terms/license.md

206


207