fastgps/mkdocs.yml at main · alegresor/fastgps · 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
145
146
site_name: "fastgps"
nav:
  - Home: index.md
  - Package Reference: api.md
  - Standard Examples:
    - Fast GP Net: examples/simple/fgp_dnb2.ipynb
    - Fast GP Lattice: examples/simple/fgp_lattice.ipynb
    - Standard GP: examples/simple/standard_gp.ipynb
    - Compare GPs: examples/simple/compare_gps_plot.ipynb
  - Multitask Examples:
    - Fast GP Net: examples/multitask/fgp_dnb2.ipynb
    - Fast GP Lattice: examples/multitask/fgp_lattice.ipynb
    - Standard GP: examples/multitask/standard_gp.ipynb
    - Compare GPs 1d: examples/multitask/compare_1d_gps_plot.ipynb
    - Compare GPs 2d: examples/multitask/compare_2d_gps_plot.ipynb
    - Elliptic PDE: examples/multitask/elliptic_pde.ipynb
  - Batch Multitask Examples:
    - Fast GP Net: examples/batch_multitask/fgp_dnb2.ipynb
    - Fast GP Lattice: examples/batch_multitask/fgp_lattice.ipynb
    - Standard GP: examples/batch_multitask/standard_gp.ipynb
  - Derivative Informed:
    - Fast GP Net: examples/derivative_informed/fgp_dnb2.ipynb
    - Fast GP Lattice: examples/derivative_informed/fgp_lattice.ipynb
    - Standard GP: examples/derivative_informed/standard_gp.ipynb
    - Compare GPs: examples/derivative_informed/compare_gps_plot.ipynb
  - Multilevel Quasi-Monte Carlo:
    - Comparison of GPs: examples/mlqmc/comparison.ipynb
    - Visualization: examples/mlqmc/visual.ipynb
  - Publications:
    - ProbNum25: examples/papers/probnum25/probnum25.ipynb
    - FMTGPs: examples/papers/fmtgps/fmtgps.ipynb
  - Miscellaneous:
    - Periodization: examples/misc/periodization.ipynb
    - Random Fourier features: examples/misc/random_fourier_features.ipynb
    - KISS Net: examples/misc/kiss_gp_dnets.ipynb


plugins:
  - search
  - mkdocs-jupyter:
      ignore_h1_titles: true    # Include H1 from notebooks
      execute: false              # Execute notebooks during build
      include_source: true       # Add download link for source notebooks
      # theme: dark               # Use dark theme for code cells
      # include: ["*.ipynb"]  # File patterns to include
      # execute_ignore: []  # Skip certain files
      # allow_errors: false        # Fail build on notebook errors
      # kernel_name: python3       # Specify kernel to use
      # show_input: true          # Show input cells by default
      # no_input: false           # Don't hide all inputs
      # remove_tag_config:
      #   remove_cell_tags:
      #     - "hide"              # Hide cells with these tags
      #     - "hide-cell"
      #   remove_all_outputs_tags:
      #     - "hide-output"       # Hide outputs for tagged cells
      #   remove_input_tags:
      #     - "hide-input"        # Hide input for tagged cells
  - mkdocstrings:
      #enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
      #custom_templates: templates
      default_handler: python
      handlers:
        python:
          paths: [fastgps]  # search packages in the src folder
          options:
            members_order: source
            show_root_toc_entry: false
            heading_level: 3
            docstring_section_style: table
            separate_signature: true
            line_length: 50
            show_submodules: true
            docstring_style: google
            docstring_options:
              ignore_init_summary: false
            merge_init_into_class: true

theme:
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
      primary: green
    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
      primary: green
  name: material
  navigation_depth: 6
  color_mode: auto
  user_color_mode_toggle: True
  features:
    # - navigation.instant
    - navigation.expand
    - toc.follow
    - navigation.sections
    - toc.integrate
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
  icon:
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
markdown_extensions:
  - toc
  - attr_list
  - admonition
  # - mdx_math
  - extra
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css