RKO_Python/mkdocs.yml at main · RKO-solver/RKO_Python · 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
site_name: RKO - Random-Key Optimizer
site_description: A Python library for Random-Key Optimization (RKO).
site_author: Felipe Silvestre Cardoso Roberto & João Assaoka
repo_url: https://github.com/RKO-solver/RKO_Python
repo_name: RKO-solver/RKO_Python

theme:
  name: material
  logo: assets/logo.jpg
  favicon: assets/favicon.png
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
  palette:
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_root_heading: true
            show_source: true

nav:
  - Home: index.md
  - API Reference:
    - RKO: reference/rko.md
    - Environment: reference/environment.md
    - LogStrategy: reference/logstrategy.md
    - Plots: reference/plots.md
  - Tutorials:
    - Knapsack Problem: tutorials/knapsack.md
    - Travelling Salesperson Problem: tutorials/tsp.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences