Xopt/mkdocs.yml at master · lee-edelen/Xopt · 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
site_name: Xopt
repo_url: https://github.com/ChristopherMayes/Xopt
repo_name: ChristopherMayes/Xopt

nav:
    - Home: index.md
    - Installation: installation.md
    - Examples:
      - examples/xopt_basic.ipynb
      - examples/xopt_parallel.ipynb
      - examples/bayesian_exploration.ipynb
    - API:
      - Xopt: api/xopt.md
      - Bayesian algorithms: api/algorithms/bayesian.md
      - Genetic algorithms: api/algorithms/genetic.md

theme:
  icon:
    repo: fontawesome/brands/github
  name: material

  custom_dir: overrides
  features:
    - navigation.top
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ChristopherMayes/Xopt
      name: Xopt

plugins:
    - search

    - mkdocs-jupyter:
        include_source: True

    - mkdocstrings:
        default_handler: python
        handlers:
          python:
            selection:
              docstring_style: "numpy"
              inherited_members: false
              filters:
                - "!^_"  # exclude all members starting with _
                - "^__init__$"  # but always include __init__ modules and methods
            rendering:
              show_source: true
              show_root_heading: true