gemseo-mlearning/mkdocs.yml at develop · gemseo/gemseo-mlearning · 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
site_name: gemseo-mlearning
site_url: https://gemseo.gitlab.io/gemseo-mlearning
repo_url: https://gitlab.com/gemseo/dev/gemseo-mlearning
repo_name: gemseo-mlearning

theme:
  name: material
  favicon: images/favicon.ico
  features:
    - navigation.tabs
    - navigation.instant
  palette:
    - scheme: default
      primary: teal
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      toggle:
        icon: material/lightbulb
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/gitlab

plugins:
- search
- markdown-exec
- gen-files:
    scripts:
    - docs/gen_ref_nav.py
- literate-nav:
    nav_file: SUMMARY.md
- section-index
- mkdocstrings:
    handlers:
      python:
        paths: [src]
        import:
        - https://docs.python.org/3/objects.inv
        - https://gemseo.readthedocs.io/en/stable/objects.inv
        - https://matplotlib.org/stable/objects.inv
        - https://numpy.org/doc/stable/objects.inv
        - https://docs.scipy.org/doc/scipy/objects.inv
        - https://openturns.github.io/openturns/latest/objects.inv
        - https://scikit-learn.org/stable/objects.inv
        options:
          extensions:
          - griffe_inherited_docstrings
          - docstring_inheritance.griffe
          - griffe_fieldz: {include_inherited: true}
          filters:
          - "!^_"
          docstring_options:
#            ignore_init_summary: true
            returns_multiple_items: False
          docstring_section_style: spacy
          # heading_level: 1
          inherited_members: true
#          preload_modules:
#          - gemseo
          merge_init_into_class: true
          separate_signature: true
          show_root_heading: true
          show_root_full_path: false
          show_signature_annotations: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          show_category_heading: true
          signature_crossrefs: true
- gallery:
    conf_script: docs/gallery_conf.py
    default_thumb_file: docs/images/monogram.png
- include-markdown
- bibtex:
    bib_file: "docs/references.bib"
- mike:
    canonical_version: latest
    # Gitlab pages expects the docs in this directory.
    deploy_prefix: public

nav:
- Home:
  - Overview: index.md
  - Changelog: changelog.md
  - Credits: credits.md
  - Licenses: licenses.md
- User guide:
  - Introduction: user_guide/index.md
  - Active learning (AL):
    - What AL is: user_guide/active_learning/what_active_learning_is.md
    - AL algorithm: user_guide/active_learning/active_learning_algo.md
    - AL for exploration: user_guide/active_learning/exploration.md
    - AL for level sets: user_guide/active_learning/level_set.md
    - AL for optimization: user_guide/active_learning/optimization.md
    - AL for quantiles: user_guide/active_learning/quantile.md
  - Optimization: user_guide/optimization/al.md
- Examples:
  - Active learning: generated/examples/active_learning
  - Optimization:  generated/examples/optimization
- API documentation: reference/gemseo_mlearning/
- Developer guide:
  - Active learning: developer_guide/active_learning.md

markdown_extensions:
- admonition
- def_list
- pymdownx.details
- md_in_html
- pymdownx.arithmatex:
    generic: true
- pymdownx.superfences:
    custom_fences:
      - name: mermaid
        class: mermaid
- footnotes
- toc:
    permalink: true
- pymdownx.snippets
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg

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

watch:
  - src/gemseo_mlearning
  - README.md
  - CHANGELOG.md

extra:
  version:
    provider: mike