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
46
47
48
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:
  - mkdocstrings:
      handlers:
        python:
          # src-layout: let griffe find the package by source path so the API
          # docs build without installing basanos into the (uvx-isolated) book
          # environment. Avoids needing `--with-editable .` in the book command.
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true

nav:
  - Home: index.md
  - Concepts:
      - Covariance Modes: concepts.md
      - Factor Models: factor-models.md
      - Streaming Guide: streaming.md
      - Performance: performance.md
  - Notebooks:
      - Demo: notebooks/demo.html
      - Diagnostics: notebooks/diagnostics.html
      - End to End: notebooks/end_to_end.html
      - EWM Benchmark: notebooks/ewm_benchmark.html
      - Factor Model Guide: notebooks/factor_model_guide.html
      - Shrinkage Guide: notebooks/shrinkage_guide.html
  - CI/CD:
      - Coverage: reports/html-coverage/index.html
      - Report: reports/html-report/report.html
  - API Reference:
      - Engine: api/engine.md
      - Configuration: api/config.md
      - Streaming API: api/stream.md
      - Risk Models & Helpers: api/models.md
      - Exceptions: api/exceptions.md