scikit-lego/mkdocs.yaml at 077b0d1228a57782b505dcff459065173f5891ae · fabioscantamburlo/scikit-lego · 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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# Project information
site_name: scikit-lego
# site_description: tbd
# site_url: tbd

# Repository information
repo_name: koaning/scikit-lego
repo_url: https://github.com/koaning/scikit-lego
edit_uri: edit/main/docs/

# Configuration
watch:
  - sklego

exclude_docs: |
  Makefile
  README.md

use_directory_urls: true
theme:
  name: material
  logo: _static/logo.png
  favicon: _static/logo.png
  font:
    text: Ubuntu
    code: Ubuntu Mono
  highlightjs: true
  hljs_languages:
    - bash
    - python
    - r
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - navigation.footer
    - navigation.top
    - navigation.tracking

    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - content.tabs.link

    - search.suggest
    - search.highlight
    - search.share

    - toc.follow

# Plugins
plugins:
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          options:
            show_symbol_type_toc: true
            docstring_style: numpy
            docstring_section_style: table # table, list or spacy
            filters:
            - "!^_"  # Hide semi-private functions and methods
            - "!^__"  # Hide private functions and methods
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - codehilite
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.snippets

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

validation:
  absolute_links: ignore
  unrecognized_links: ignore

nav:
  - Home:
    - Home: index.md
    - Installation: installation.md
    - Contribution: contribution.md
  - User guide:
    - Datasets: user-guide/datasets.md
    - Linear Models: user-guide/linear-models.md
    - Mixture Methods: user-guide/mixture-methods.md
    - Naive Bayes: user-guide/naive-bayes.md
    - Meta Models: user-guide/meta-models.md
    - Fairness: user-guide/fairness.md
    - Outliers: user-guide/outliers.md
    - Preprocessing: user-guide/preprocessing.md
    - Cross Validation: user-guide/cross-validation.md
    - Debug Pipeline: user-guide/debug-pipeline.md
    - Pandas Pipelines: user-guide/pandas-pipelines.md
    - RStudio: rstudio.md
  - API Reference:
    - Base: api/base.md
    - Common: api/common.md
    - Datasets: api/datasets.md
    - Decay Functions: api/decay-functions.md
    - Decomposition: api/decomposition.md
    - Dummy: api/dummy.md
    - Linear Model: api/linear-model.md
    - Meta: api/meta.md
    - Metrics: api/metrics.md
    - Mixture: api/mixture.md
    - Model Selection: api/model-selection.md
    - Features Selection: api/features-selection.md
    - Naive Bayes: api/naive-bayes.md
    - Neighbors: api/neighbors.md
    - Pandas Utils: api/pandas-utils.md
    - Pipeline: api/pipeline.md
    - Preprocessing: api/preprocessing.md
  - This: this.md

not_in_nav: |
  _static