TiPortfolio/mkdocs.yml at master · TradeInsight-Info/TiPortfolio · 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
site_name: TiPortfolio Docs
repo_url: https://github.com/TradeInsight-Info/TiPortfolio

theme:
  name: material
  features:
    - search.highlight
    - search.suggest
    - navigation.footer

plugins:
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            members_order: source
  - search

extra:
  version:
    provider: mike

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid

nav:
  - Home: index.md
  - CLI: cli.md
  - Built-in Strategies:
    - guides/fix-time-rebalance.md
    - guides/market-volatility-rebalance.md
    - guides/allocation-strategies.md
  - Guides:
    - Debug: debug.md
    - Usage: guides/usage.md
    - guides/key-data-types.md
    - guides/comparing-results.md
    - guides/extra-data.md
  - Why TiPortfolio:
    - about.md
    - thoughts.md
  - API:
    - Overview: api/index.md
    - Project Structure: api/structure.md
    - Reference: api/reference.md
  - Others:
    - Researching: papers.md
    - Changelog: https://github.com/TradeInsight-Info/TiPortfolio/releases