PyEyesWeb/mkdocs.yml at main · InfoMusCP/PyEyesWeb · 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
site_name: PyEyesWeb
repo_url: https://github.com/InfoMusCP/PyEyesWeb
site_url: https://infomuscp.github.io/PyEyesWeb/

plugins:
  - search
  - macros
  - gen-files:
      scripts:
        - docs/scripts/gen_pages.py
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: numpy
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index

markdown_extensions:
  - admonition
  - footnotes
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.snippets
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.arithmatex:
      generic: true

theme:
  name: readthedocs
  custom_dir: docs/overrides
  logo: assets/eyesweb-logo.png
  favicon: assets/favicon-32x32.png
extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
  - javascripts/version-select.js

extra_css:
  - overrides/extra.css

copyright: Copyright &copy; 2025 Casa Paganini - InfoMus, Genoa, Italy. All rights reserved.

nav:
  - Home: index.md
  - User Guide:
      - Getting Started: user_guide/getting_started.md
      - Theoretical Framework:
          - user_guide/theoretical_framework/theoretical_framework.md
          - Layer 1 - Physical Signals:
              - user_guide/theoretical_framework/physical_signals/physical_signals.md
          - Layer 2 - Low-Level Features:
              - user_guide/theoretical_framework/low_level/low_level.md
              - Contraction Expansion: user_guide/theoretical_framework/low_level/contraction_expansion.md
              - Direction Change: user_guide/theoretical_framework/low_level/direction_change.md
              - Kinetic Energy: user_guide/theoretical_framework/low_level/kinetic_energy.md
              - Geometric Symmetry: user_guide/theoretical_framework/low_level/geometric_symmetry.md
              - Postural Balance: user_guide/theoretical_framework/low_level/postural_balance.md
              - Smoothness: user_guide/theoretical_framework/low_level/smoothness.md
          - Layer 3 - Mid-Level Features:
              - user_guide/theoretical_framework/mid_level/mid_level.md
              - Impulsivity: user_guide/theoretical_framework/mid_level/impulsivity.md
              - Lightness: user_guide/theoretical_framework/mid_level/lightness.md
              - Suddenness: user_guide/theoretical_framework/mid_level/suddenness.md
          - Layer 4 - High-Level Features:
              - user_guide/theoretical_framework/high_level/high_level.md
          - Analysis Primitives:
              - user_guide/theoretical_framework/analysis_primitives/analysis_primitives.md
              - Clusterability: user_guide/theoretical_framework/analysis_primitives/clusterability.md
              - MSE Dominance: user_guide/theoretical_framework/analysis_primitives/mse_dominance.md
              - Rarity: user_guide/theoretical_framework/analysis_primitives/rarity.md
              - Statistical Moment: user_guide/theoretical_framework/analysis_primitives/statistical_moment.md
              - Synchronization: user_guide/theoretical_framework/analysis_primitives/synchronization.md
      - Integrations: user_guide/integrations.md
  - API: API/