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

site_name: cvx-linalg
site_description: Linear algebra utilities for portfolio optimization
site_author: Jebel Quant Research
site_url: https://jebel-quant.github.io/linalg/
repo_url: https://github.com/Jebel-Quant/linalg
repo_name: Jebel-Quant/linalg
copyright: Copyright &copy; 2025–2026 Jebel Quant Research

nav:
  - Home: index.md
  - API Reference: api.md
  - Numerical Behavior: numerical-behavior.md
  - Notebooks:
    - End to End: notebooks/end_to_end.html
    - Norms and Validity: notebooks/norms_and_validity.html
  - Reports:
    - Test Report: reports/html-report/report.html
    - Coverage Report: reports/html-coverage/index.html
    - Hypothesis Report: reports/hypothesis/report.html
  - Development:
    - Rhiza: development/rhiza.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Jebel-Quant/linalg

theme:
  icon:
    logo: material/matrix

plugins:
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true