ssm-simulators/mkdocs.yml at main · lnccbrown/ssm-simulators · 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
site_name: SSMS (Sequential Sampling Model Simulators)
repo_name: lnccbrown/ssm-simulators
repo_url: https://github.com/lnccbrown/ssm-simulators
site_url: https://lnccbrown.github.io/ssm-simulators
edit_uri: edit/main/docs

nav:
  - Home:
      - Overview: index.md
  - Getting Started:
      - Basic Tutorial: basic_tutorial/basic_tutorial.ipynb
  - Core Tutorials:
      - Package Overview: core_tutorials/tutorial_capabilities.ipynb
      - Configuration Systems: core_tutorials/tutorial_configs.ipynb
      - Custom Models: core_tutorials/tutorial_custom_models.ipynb
      - Data Generators: core_tutorials/tutorial_data_generators.ipynb
      - KDE Class: core_tutorials/kde_class.ipynb
      - PyDDM Integration: core_tutorials/tutorial_simulators_vs_pyddm.ipynb
      - Using MLflow: core_tutorials/using_mlflow.md
  - Contributing:
      - Contribute New Models: contributing/add_models.md
      - Contribute Parameter Adapters: contributing/add_parameter_adapters.md

  - API:
      - ssms: api/ssms.md
      - basic simulators: api/basic_simulators.md
      - config: api/config.md
      - data generators: api/dataset_generators.md
      - support utils: api/support_utils.md

plugins:
  - search
  - autorefs
  - mkdocs-jupyter:
      execute: True
      # execute_ignore:
      #   - basic_tutorial/basic_tutorial.ipynb
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://mkdocstrings.github.io/objects.inv
            - https://mkdocstrings.github.io/griffe/objects.inv
          options:
            show_submodules: true
            separate_signature: true
            merge_init_into_class: true
            docstring_options:
              ignore_init_summary: true
            docstring_style: "numpy"
            docstring_section_style: "list"
            show_root_members_full_path: true
            show_object_full_path: false
            show_category_heading: true
            show_signature_annotations: false
            show_source: false
            group_by_category: false
            signature_crossrefs: true

theme:
  name: material
  custom_dir: docs/overrides
  features:
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.path
    - navigation.top
    - content.code.copy
    - content.action.view
    - content.action.edit
    - header.autohide
    - announce.dismiss
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to dark mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to light mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to automatic mode

extra:
  homepage: "https://lnccbrown.github.io/ssm-simulators/"

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg