PhilanthroPy/mkdocs.yml at main · PhilanthroPy-Project/PhilanthroPy · 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
site_name: PhilanthroPy
site_description: A scikit-learn compatible toolkit for predictive donor analytics.
repo_url: https://github.com/PhilanthroPy-Project/PhilanthroPy

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  palette:
    scheme: slate
    primary: teal
    accent: amber
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.magiclink
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: numpy
            show_source: true
            members_order: source

nav:
  - Home: index.md
  - Tutorials:
    - tutorials/index.md
    - tutorials/building_your_first_model.md
    - tutorials/avoiding_temporal_data_leakage.md
    - tutorials/building_a_grateful_patient_pipeline.md
  - How-To Guides:
    - how-to/index.md
    - how-to/handle_missing_wealth_data.md
    - how-to/build_grateful_patient_features.md
    - how-to/develop_and_test.md
  - Explanation:
    - explanation/index.md
    - explanation/fundraising_metrics.md
    - explanation/capacity_and_loyalty.md
    - explanation/design_principles.md
  - API Reference:
    - reference/index.md
    - reference/preprocessing.md
    - reference/models.md
    - reference/metrics.md
    - reference/datasets.md
    - reference/model_selection.md