bs-python-utils/mkdocs.yml at main · bsalanie/bs-python-utils · 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
site_name: bs-python-utils
repo_url: https://github.com/bsalanie/bs-python-utils
site_url: https://bsalanie.github.io/bs-python-utils
site_description: my Python utilities
site_author: Bernard Salanie
edit_uri: edit/main/docs/
repo_name: bsalanie/bs-python-utils
copyright: Maintained by <a href="https://bsalanie.github.io">Bernard Salanie</a>.

nav:
  - Home: index.md
  - API Reference:
    - core:
      - error reporting and other utilities: bsutils.md
      - logging: bs_logging.md
      - math strings: bs_mathstr.md
      - timing routines: Timer.md
      - memory usage: bs_mem.md
    - numerical:
      - NumPy: bsnputils.md
      - SciPy: bssputils.md
      - Chebyshev interpolation and integration: chebyshev.md
      - sparse integration for functions of Gaussians: bs_sparse_gaussian.md
    - opt:
      - optimization: bs_opt.md
    - stats:
      - statistics: bsstats.md
      - nonlinear dependence: distance_covariances.md
      - bivariate quantiles and ranks: bivariate_quantiles.md
    - data_anal:
      - Pandas: pandas_utils.md
      - scikit-learn: sklearn_utils.md
    - viz:
      - plotting interface: bs_plots.md
      - Matplotlib: bsmplutils.md
      - Seaborn: bs_seaborn.md
      - Altair: bs_altair.md
      - Streamlit: streamlit_utils.md

plugins:
  - search:
  - mkdocstrings:
      handlers:
        python:
          paths:


# theme:
#   palette:
#     scheme: preference


# to navigate with `/site` content correctly
use_directory_urls: false

theme:
  name: material
  features:
    - search.highlight
    - navigation.instant
    - navigation.expand
    - navigation.tabs
    - navigation.indexed
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/bsalanie/bs-python-utils
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/bs-python-utils

markdown_extensions:
  - attr_list
  - pymdownx.superfences
  - pymdownx.highlight:
      linenums: true
  - toc:
      permalink: true
  - admonition # add notes, warnings...
  - codehilite
  - toc
  - pymdownx.arithmatex: # for LaTeX
      generic: true
extra_javascript: # for arithmatex
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js