spotPython/mkdocs.yml at main · sequential-parameter-optimization/spotPython · 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
site_name: spotpython
site_description: spotpython - Sequential Parameter Optimization Toolbox in Python
site_url: https://github.com/sequential-parameter-optimization/spotpython
repo_url: https://github.com/sequential-parameter-optimization/spotpython/tree/main

# Copyright
copyright: Copyright &copy; 2004 - 2023

nav:
- Home: index.md
- Code Reference: reference/
- Documentation: hyperparameter-tuning-cookbook.md
- Download: download.md
- Examples: examples.md
- About: about.md

theme:
  name: material
  locale: en
  highlightjs: true
  favicon: images/favicon.png
  logo: images/spotlogo.png

  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: grey
      accent: orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue grey
      accent: orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Fira Code
  features:
    - content.code.copy
    - navigation.tabs
    - navigation.instant
    - navigation.indexes

plugins:
    - search:
    - exclude:
        glob:
        - src/spotpython/_version.py
    - gen-files:
        scripts:
        - docs/gen_ref_pages.py
    - literate-nav:
        nav_file: SUMMARY.md
    - section-index
    - mkdocstrings:
markdown_extensions:
    - smarty
    - sane_lists
    - toc:
        permalink: True
    - pymdownx.arithmatex:
        generic: true
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
use_directory_urls: true
watch:
- src/spotpython
extra:
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/bartzbeielstein
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/thomas-bartz-beielstein-3157b541/