RumMeatPy/mkdocs.yml at main · rumcode/RumMeatPy · GitHub

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
site_name: MeatPy
site_description: A framework for processing high-frequency financial market data
site_author: Vincent Grégoire, Charles Martineau
site_url: https://www.vincentgregoire.com/MeatPy

repo_name: vgreg/MeatPy
repo_url: https://github.com/vgreg/MeatPy

theme:
  name: material
  logo: images/meatpy.svg
  favicon: images/meatpy.svg
  palette:
    - scheme: default
      primary: green
      accent: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: green
      accent: green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.share
    - content.code.copy

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - attr_list

nav:
  - Home: index.md
  - Installation: installation.md
  - User Guide:
    - Getting Started: guide/getting-started.md
    - Listing Symbols: guide/01_listing_symbols.ipynb
    - Extracting Symbols: guide/02_extracting_symbols.ipynb
    - Top of Book Snapshots: guide/03_top_of_book_snapshots.ipynb
    - Full LOB Snapshots: guide/04_full_lob_snapshots.ipynb
  - Contributing: contributing.md

plugins:
  - search
  - autorefs
  - mkdocs-jupyter:
      execute: false
      allow_errors: false
      include_source: true