cpm/mkdocs.yml at main · DevComPsy/cpm · 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
site_name: CPM library
theme:
  name: readthedocs
  highlightjs: true
  hljs_languages:
    - python
    - bash
    - yaml
    - json
    - markdown
    - makefile

extra_css:
  - style.css

extra_javascript:
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML

plugins:
  - search
  - mkdocstrings:
      enable_inventory: false
      handlers:
        # See: https://mkdocstrings.github.io/python/usage/
        python:
          load_external_modules: true
          options:
            show_source: false
            docstring_style: numpy
            docstring_section_style: table
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
  - mkdocs-jupyter:
            no_input: False
            include_source: True
            ignore: ['examples/bandit.py']

nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - Troubleshooting: troubleshooting.md
      - Roadmap: roadmap.md
  - Examples:
      - examples/cpm-toolbox-complete-walkthrough.ipynb
      - examples/associative-learning.ipynb
      - examples/bandit-task.ipynb
      - examples/metacognition.ipynb
      - examples/model-parameter-recovery.ipynb
      - examples/model-recovery.ipynb
      - examples/fitting-hierarchical-estimation.ipynb
      - examples/fitting-hierarchical.ipynb
      - examples/hpc-example.ipynb
  - API Reference:
      - cpm.applications: api/applications.md
      - cpm.datasets: api/datasets.md
      - cpm.models: api/models.md
      - cpm.generators: api/generators.md
      - cpm.optimisation: api/optimisation.md
      - cpm.hierarchical: api/hierarchical.md
      - cpm.utils: api/utils.md

markdown_extensions:
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - mdx_math:
        enable_dollar_delimiter: True #for use of inline $..$