FinancePy/mkdocs.yml at master · domokane/FinancePy · 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
site_name: FinancePy
site_description: "A Finance Securities Valuation Library"
site_author: "Dominic O'Kane"
repo_url: https://github.com/domokane/FinancePy
repo_name: FinancePy
edit_uri: ""

theme:
  name: material
  logo: images/logo.png   # optional if you have a logo
  favicon: images/favicon.png
  palette:
    - scheme: default
      primary: blue
      accent: cyan
    - scheme: slate
      primary: blue
      accent: cyan
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

nav:
  - Home: index.md
  - Quick Start: quickstart.md
  - Tutorials:
      - Bonds: tutorials/bonds.md
      - Options: tutorials/options.md
      - Credit: tutorials/credit.md
  - API Reference:
      - Products: api/products.md
      - Models: api/models.md
      - Markets: api/markets.md
      - Utils: api/utils.md
  - Examples: examples.md
  - About: about.md

markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - meta
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            heading_level: 2
            docstring_style: google
  - mkdocs-jupyter:
      execute: false   # set true if you want notebooks auto-executed

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/domokane/FinancePy
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/financepy/