basanos/mkdocs.yml at main · Jebel-Quant/basanos · 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
INHERIT: docs/mkdocs-base.yml

site_name: basanos
site_description: Correlation-aware portfolio optimization and analytics for Python.
site_url: https://jebel-quant.github.io/basanos/
repo_url: https://github.com/Jebel-Quant/basanos
repo_name: Jebel-Quant/basanos

docs_dir: docs

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            heading_level: 2
            members_order: source
            show_signature_annotations: true
            members: true
            show_submodules: true

nav:
  - Home: index.md
  - Concepts:
    - Covariance Modes: concepts.md
    - Factor Models: factor-models.md
    - Streaming Guide: streaming.md
    - Performance: performance.md
    - Engine Architecture: ARCHITECTURE.md
  - Notebooks: notebooks.md
  - Reports: reports.md
  - API Reference:
    - Overview: api.md
    - Engine: api/engine.md
    - Configuration: api/config.md
    - Streaming API: api/stream.md
    - Risk Models & Helpers: api/models.md
    - Exceptions: api/exceptions.md