CompNeuroPy/mkdocs.yml at master · Olimaol/CompNeuroPy · 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
site_name: CompNeuroPy
site_url: https://olimaol.github.io/CompNeuroPy/

theme:
  name: material

  features:
     - header.autohide
     - content.code.copy

  palette:
    primary: black
    accent: indigo

  icon:
    repo: fontawesome/brands/github

copyright: Copyright &copy; Oliver Maith
repo_url: https://github.com/Olimaol/CompNeuroPy

extra_css:
  - stylesheets/extra.css

extra:
  version:
    provider: mike
    alias: true

plugins:
  - search
  - mkdocstrings:
      handlers:
          python:
            options:
              heading_level: 2
              show_root_heading: true
              members_order: source
              docstring_style: google
            selection:
                new_path_syntax: true

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - toc:
      permalink: "#"


nav:
  - Home: 'index.md'
  - Installation: 'installation.md'
  - 'Main Features':
    - Generate Models: 'main/generate_models.md'
    - Generate Simulations: 'main/generate_simulations.md'
    - Monitors / Recordings: 'main/monitors_recordings.md'
    - Optimize a neuron model: 'main/optimize_neuron.md'
    - Define Experiments: 'main/define_experiment.md'
    - DBS Stimulator: 'main/dbs_stimulator.md'
    - Model Configurator: 'main/model_configurator.md'
  - 'Built-in Models':
    - Full Models: 'built_in/models.md'
    - Neuron Models: 'built_in/neuron_models.md'
    - Synapse Models: 'built_in/synapse_models.md'
  - 'Additional Features':
    - Simulation Functions: 'additional/simulation_functions.md'
    - Simulation Requirements: 'additional/simulation_requirements.md'
    - Analysis Functions: 'additional/analysis_functions.md'
    - Model Functions: 'additional/model_functions.md'
    - System Functions: 'additional/system_functions.md'
    - Extra Functions: 'additional/extra_functions.md'
    - Statistic Functions: 'additional/statistic_functions.md'
  - 'Examples':
    - Generate Models: 'examples/generate_models.md'
    - Generate Simulations: 'examples/run_and_monitor_simulations.md'
    - Monitor Recordings: 'examples/monitor_recordings.md'
    - Plot Recordings: 'examples/plot_recordings.md'
    - Define Experiments: 'examples/experiment.md'
    - DBS Simulator: 'examples/dbs.md'
    - Optimize a neuron model: 'examples/opt_neuron.md'
    - Cma Optimization: 'examples/deap_cma.md'
  - License: 'license.md'