DESDEO/mkdocs.yml at master · TPScience/DESDEO · 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
site_name: "DESDEO documentation"
repo_url: "https://github.com/industrial-optimization-group/DESDEO"
repo_name: "GitHub"
docs_dir: "docs"
site_dir: "site"
site_url: "https://desdeo.readthedocs.io/en/latest/"

nav:
  - Home: "index.md"
  - "DESDEO":
      - "": "home/index.md"
      - "About": "home/about.md"
      - "The structure": "home/structure.md"
      - "Citing DESDEO": "home/citing.md"
  - "Tutorials":
      - "": "tutorials/index.md"
      - "A primer on interactive multiobjective optimization": "tutorials/moo_primer.md"
      - "Contributing to DESDEO": "tutorials/contributing.md"
  - "Explanation":
      - "": "explanation/index.md"
      - "The problem format": "explanation/problem_format.ipynb"
      - "Parsing and evaluating": "explanation/parsing_and_evaluating.ipynb"
      - "Scalarization": "explanation/scalarization.ipynb"
      - "Scalarization methods": "explanation/scalarization_methods.ipynb"
      - "Simulator support": "explanation/simulator_support.ipynb"
      - "Solvers": "explanation/solvers.ipynb"
      - "Test problems": "explanation/test_problems.ipynb"
      - "Evolutionary algorithms": "explanation/templates_and_pub_sub.ipynb"
      - "Web-API models and schema": "explanation/database_models_and_schema.md"
  - "Guides":
      - "": "howtoguides/index.md"
      - "How to install DESDEO": "howtoguides/installing.md"
      - "How to get started using DESDEO": "howtoguides/full_example.ipynb"
      - "How to define a multiobjective optimization problem": "howtoguides/how_to_define_a_problem.ipynb"
      - "How to host a DESDEO web application on Kubernetes": "howtoguides/kubernetes.md"
      - "How to run DESDEO's web-API and web-GUI": "howtoguides/api_and_gui.md"
      - "How to utilize 'MCDM' methods": "howtoguides/how_to_utilize_mcdm_methods.ipynb"
      - "How to use the NAUTILUS Navigator method": "howtoguides/nautilus_navigator.md"
      - "How to use the NAUTILI method": "howtoguides/nautili.md"
      - "How to use the Pareto navigator method": "howtoguides/pareto_navigator.md"
      - "How to user evolutionary algorithms": "howtoguides/ea.ipynb"
      - "How to define problems with surrogates": "howtoguides/advancedSurrogates.ipynb"
      - "How to generate a representative set of solutions": "howtoguides/IPR.ipynb"
  - "Core-Logic Reference":
      - "desdeo-problem": "api/desdeo_problem.md"
      - "desdeo-mcdm": "api/desdeo_mcdm.md"
      - "desdeo-emo": "api/desdeo_emo.md"
      - "desdeo-tools": "api/desdeo_tools.md"
      - "DESDEO REST API": "api/desdeo_api.md"
  - "Web-API":
      - "": "web_api/index.md"
      - "OpenAPI reference": "web_api/openapi.md"
      - "Database models": "web_api/models.md"
      - "Database relations mapping": "web_api/relations.md"
  - "Web-GUI":
      - "": "web_gui/index.md"

watch:
  - desdeo

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tabs
    - palette.switch
    - navigation.tabs
    - navigation.tabs.sticky
    - content.code.annotate
  nav_style: dark
  highlightjs: true
  hljs_languages:
    - python
    - json
  locale: en
  palette:
    scheme: slate
    primary: black
  logo: assets/desdeo_logo.png
  favicon: assets/desdeo_logo.png

plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_bases: true
            show_signature_annotations: true
            show_type_annotations: true
            show_root_heading: true
            separate_signature: true
            heading_level: 2
            merge_init_into_class: false
            show_root_toc_entry: false
            group_by_category: true
            show_category_heading: false
            show_symbol_type_heading: true
            show_symbol_type_doc: true
            filters: []
          docstring_options:
            ignore_init_summary: false
  - include-markdown
  - mkdocs-jupyter:
      execute: false
      include_requirejs: true
      custom_mathjax_url: "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS_CHTML-full,Safe"
      remove_tag_config:
        remove_input_tags:
          - hide_code
        remove_cell_tags:
          - remove_cell
  - neoteroi.mkdocsoad:
      use_pymdownx: true

markdown_extensions:
  - admonition
  - mdx_math
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details

extra_css:
  - stylesheets/extra.css
  - stylesheets/neoteroi-mkdocs.css

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