psyphy/mkdocs.yml at main · flatironinstitute/psyphy · 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
site_name: psyphy
site_description: Psychophysical modeling and adaptive trial placement
site_url: https://flatironinstitute.github.io/psyphy/
repo_url: https://github.com/flatironinstitute/psyphy
repo_name: flatironinstitute/psyphy

theme:
  name: material
  logo: images/psyphy_logo.png
  features:
    - navigation.tabs
    - navigation.sections
    - content.code.copy
    - toc.integrate
  palette:
    - scheme: default        # Light mode
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate          # Dark mode
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

# Custom colors via CSS
extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - mkdocstrings: # auto-generate API reference from docstrings
      default_handler: python
      handlers:
        python:
          paths: [src]
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://pytorch.org/docs/stable/objects.inv
          options: # See https://mkdocstrings.github.io/python/usage/
            annotations_path: brief
            docstring_style: numpy
            docstring_section_style: table
            heading_level: 1
            members_order: alphabetical
            inherited_members: true
            filters:
              - "!^_"
              - "!^__"
            merge_init_into_class: true
            parameter_headings: false
            separate_signature: true
            show_if_no_docstring: true
            show_labels: false
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_source: true
            show_submodules: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary:
              modules: false
              classes: true
              functions: true
              attributes: true


markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      linenums: true
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
      base_path: ["examples", "."]
      dedent_subsections: true # If code is extracted from a file, dedent it.

nav:
  - Home: index.md
  - Quickstart: usage.md
  - API:
    - Overview: reference/overview.md
    - Reference: reference.md
    - Data: reference/data.md
    - Model: reference/model.md
    - Inference: reference/inference.md
    - Posterior: reference/posterior.md
    - Trial Placement: reference/trial_placement.md
    - Utils: reference/utils.md
  - Examples:
    - Overview: examples/index.md
    - Quick Start: examples/wppm/quick_start.md
    - Fitting with the Wishart Psychophysical Process Model (WPPM): examples/wppm/full_wppm_fit_example.md
    - Covariance Field Visualization: examples/covariance_field/covariance_field.md
  - Design Doc: API_DESIGN_DOCUMENT.md
  - Contributing: CONTRIBUTING.md

extra_javascript:
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js