curo_python/mkdocs.yml at main · andrewmurphy353/curo_python · 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
site_name: Curo Documentation
theme:
  name: material
plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            heading_level: 2
            members_order: source
            docstring_style: google  # Alt is numpy
          paths: ["curo"]
nav:
  - Home: index.md
  - Examples:
      - Overview: examples/overview.md
      - Example 1: examples/example_01.md
      - Example 2: examples/example_02.md
      - Example 3: examples/example_03.md
      - Example 4: examples/example_04.md
      - Example 5: examples/example_05.md
      - Example 6: examples/example_06.md
  - API Reference:
      - Calculator: api/calculator.md
      - Series: api/series.md
      - Enums: api/enums.md
      - Utilities: api/utils.md
      - Exceptions: api/exceptions.md
      - Day Count Conventions:
          - Overview: api/daycounts/overview.md
          - Actual/360: api/daycounts/actual_360.md
          - Actual/365: api/daycounts/actual_365.md
          - Actual/ISDA: api/daycounts/actual_isda.md
          - EU 30/360: api/daycounts/eu_30_360.md
          - EU 2008/48 APR: api/daycounts/eu_2008_48.md
          - UK Conc App APR: api/daycounts/uk_conc_app.md
          - US 30/360: api/daycounts/us_30_360.md
          - US 30U/360: api/daycounts/us_30u_360.md
          - US Appendix J APR: api/daycounts/us_appendix_j.md
  - Changelog: changelog.md

markdown_extensions:
  - pymdownx.superfences
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.inlinehilite
  - def_list
  - attr_list
  - admonition

repo_url: https://github.com/andrewmurphy353/curo_python