OpenReservoirComputing/mkdocs.yml at main · Jan-Williams/OpenReservoirComputing · 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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
site_name: OpenReservoirComputing Documentation
site_description: GPU accelerated implementations of common RC architectures
site_author: Dima Tretiak, Jan P. Williams
site_url: https://Jan-Williams.github.io/OpenReservoirComputing/

repo_name: Jan-Williams/OpenReservoirComputing
repo_url: https://github.com/Jan-Williams/OpenReservoirComputing

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: custom
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: custom
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            merge_init_into_class: true
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
  - mkdocs-jupyter:
      execute: true
      allow_errors: false
      include_source: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - attr_list
  - md_in_html
  - toc:
      permalink: true

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# Copy static files to the docs site
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Jan-Williams/OpenReservoirComputing

# Include additional directories
docs_dir: docs
site_dir: site
exclude_docs: |
  examples/benchmark_combined.py

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - User Guide:
      - Overview: user-guide/overview.md
      - Drivers: user-guide/drivers.md
      - Embeddings: user-guide/embeddings.md
      - Readouts: user-guide/readouts.md
      - Models: user-guide/models.md
      - Data: user-guide/data.md
  - Examples:
      - Lorenz System: examples/lorenz.ipynb
      - RC Background: examples/rc_background.ipynb
      - Continuous RC: examples/continuous_rc.ipynb
      - Classification: examples/classification.ipynb
      - Control: examples/control.ipynb
      - Data Library: examples/data_library.ipynb
      - Kuramoto-Sivashinsky: examples/ks.ipynb
      - JAX JIT Compatibility: examples/jit_compatibility.ipynb
  - API Reference:
      - Forecaster: api/forecaster.md
      - Classifier: api/classifier.md
      - Control: api/control.md
      - Drivers: api/drivers.md
      - Embeddings: api/embeddings.md
      - Readouts: api/readouts.md
      - Data: api/data.md
      - Utils: api/utils.md
  - Contributing: contributing.md