sweetbean/mkdocs.yml at main · AutoResearch/sweetbean · 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
site_name: SweetBean
repo_url: 'https://github.com/AutoResearch/sweetbean'
site_url: 'https://autoresearch.github.io/sweetbean/'
edit_uri: 'blob/main/docs/'

extra:
  colab_base_url: 'https://colab.research.google.com/github/AutoResearch/sweetbean/blob/gh-pages/'

theme:
  name: material
  # logo: img/logo.png
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: black
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  custom_dir: mkdocs/overrides
  features:
    - navigation.indexes
    - content.code.copy
    - announce.dismiss

  extra:
    social:
      - icon: fontawesome/brands/github-alt
        link: https://github.com/AutoResearch

extra_css:
  - styles.css

hooks:
  - mkdocs/hooks.py

watch:
  - src/sweetbean

plugins:
  - search
  - macros
  - gen-files:
      scripts:
        - mkdocs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      handlers:
        python:
          import:
            - https://scikit-learn.org/stable/objects.inv
  - mkdocs-jupyter: # required to convert Jupyter notebooks
      include_source: true
      execute: false


markdown_extensions:
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - attr_list


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


nav:
  - Introduction: 'index.md'
  - Installation & Compatibility: 'installation.md'
  - Basic Tutorials: Basic Tutorials/
  - Use Case Tutorials: Use Case Tutorials/
  - User Guide:
      - Home: 'User Guide/index.md'
      - Overview: 'User Guide/overview.md'
      - Timeline Variables: 'User Guide/timeline_variables.md'
      - Function Variables: 'User Guide/function_variables.md'
      - Data Variables: 'User Guide/data_variables.md'
      - Shared Variables And Side Effects: 'User Guide/shared_variables_and_side_effects.md'
      - LLM - Synthetic Participant: 'User Guide/llm_synthetic_participant.md'
      - Automated Generation of Stimulus Sequence Figures: 'User Guide/documentation_stimulus_sequence.md'
      - Stimuli: Stimuli/
      - Extensions: Extensions/
  - Contributor Guide: 'CONTRIBUTING.md'
  - Code Reference: reference/