Skip to content

Commit dd298ef

Browse files
change doc theme to readthedocs
1 parent 32c4b3b commit dd298ef

File tree

3 files changed

+54
-40
lines changed

3 files changed

+54
-40
lines changed

docs/index.md

Lines changed: 33 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,29 @@ title: PyEyesWeb
44

55
---
66

7-
![Open Source](https://img.shields.io/badge/Open%20Source-Yes-brightgreen)
8-
![Platform](https://img.shields.io/badge/Platform-Python-blue)
9-
![Domain](https://img.shields.io/badge/Domain-Movement%20Analysis-purple)
7+
[//]: # (![Open Source](https://img.shields.io/badge/Open%20Source-Yes-brightgreen))
8+
9+
[//]: # (![Platform](https://img.shields.io/badge/Platform-Python-blue))
10+
11+
[//]: # (![Domain](https://img.shields.io/badge/Domain-Movement%20Analysis-purple))
1012

1113

1214
<div class="hero" markdown>
1315

14-
# PyEyesWeb
15-
Movement Analysis Toolkit
16+
# PyEyesWeb
17+
**Movement Analysis Toolkit**
1618

17-
:material-rocket-launch: **Extract features** from raw human movement data
18-
:material-school: **Apply in science, health, and the arts**
19-
:material-handshake: **Developed with the partial support of the [EU ICT STARTS Resilence Project](https://resilence.eu/)**
19+
![Open Source](https://img.shields.io/badge/Open%20Source-Yes-brightgreen)
20+
![Platform](https://img.shields.io/badge/Platform-Python-blue)
21+
![Domain](https://img.shields.io/badge/Domain-Movement%20Analysis-purple)
2022

21-
[:octicons-book-24: Get Started](user_guide/getting_started.md){ .md-button .md-button--primary } [:material-github: GitHub Repository](https://github.com/InfoMusCP/PyEyesWeb){ .md-button }
23+
---
2224

23-
</div>
25+
🚀 **Extract features** from raw human movement data
26+
🎓 **Apply in science, health, and the arts**
27+
🤝 **Developed with the partial support of the [EU ICT STARTS Resilence Project](https://resilence.eu/)**
28+
29+
**[📖 Get Started](user_guide/getting_started.md)** | **[GitHub Repository](https://github.com/InfoMusCP/PyEyesWeb)**
2430

2531
---
2632

@@ -51,34 +57,18 @@ Originally started in 1997, EyesWeb has been adopted worldwide in scientific res
5157

5258
## Use Cases
5359

54-
<div class="grid cards" markdown>
55-
56-
- :material-school:{ .lg .middle } **Research & Science**
57-
58-
---
59-
60+
* **🎓 Research & Science**
6061
Quantify movement expressivity and analyze biomechanics with validated methods.
6162

62-
- :material-connection:{ .lg .middle } **Interactive Media**
63-
64-
---
65-
63+
* **🔗 Interactive Media**
6664
Integrate PyEyesWeb in real-time with [TouchDesigner](user_guide/integrations).
6765

68-
- :material-hospital:{ .lg .middle } **Health & Rehabilitation**
69-
70-
---
71-
66+
* **🏥 Health & Rehabilitation**
7267
Assess movement disorders, monitor recovery, and support clinical studies.
7368

74-
- :material-theater:{ .lg .middle } **Artistic Performance**
75-
76-
---
77-
69+
* **🎭 Artistic Performance**
7870
Explore synchrony, smoothness, and expressive qualities in dance and live performance.
7971

80-
</div>
81-
8272
---
8373

8474
## Methodological Foundation
@@ -113,16 +103,22 @@ funded by the European Union’s Horizon programme.
113103
</div>
114104
---
115105

116-
## Explore the Documentation
106+
[//]: # (## Explore the Documentation )
107+
108+
[//]: # ()
109+
[//]: # (- 🚀 [Getting Started]&#40;user_guide/getting_started.md&#41; – install, examples, and feature list)
110+
111+
[//]: # (- 🎭 [TouchDesigner Plugin]&#40;https://github.com/InfoMusCP/PyEyesWebTD&#41;)
112+
113+
[//]: # ()
114+
[//]: # (## Roadmap )
117115

118-
- 🚀 [Getting Started](user_guide/getting_started.md) – install, examples, and feature list
119-
- 🎭 [TouchDesigner Plugin](https://github.com/InfoMusCP/PyEyesWebTD)
116+
[//]: # ()
117+
[//]: # (- Expand expressive feature extraction modules for movement analysis )
120118

121-
## Roadmap
119+
[//]: # (- Extend integrations with platforms like Unity and Max/MSP )
122120

123-
- Expand expressive feature extraction modules for movement analysis
124-
- Extend integrations with platforms like Unity and Max/MSP
125-
- Develop collaborative research tools and shared datasets
121+
[//]: # (- Develop collaborative research tools and shared datasets)
126122

127123
!!! info "Community & Collaboration"
128124
Whether you are a **researcher, artist, or developer**, PyEyesWeb helps you bridge movement, computation, and expression.

main.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
import toml
2+
3+
4+
def define_env(env):
5+
try:
6+
# Load pyproject.toml
7+
with open("pyproject.toml", "r") as f:
8+
data = toml.load(f)
9+
10+
# This example attempts to find it in [project] first, then falls back to [tool.poetry]
11+
version = data.get("project", {}).get("version")
12+
print(version)
13+
14+
env.conf['extra']['version'] = version
15+
print(env.variables.project_version)
16+
except Exception as e:
17+
print(f"Error loading version from pyproject.toml: {e}")
18+
env.variables.project_version = "Error"

mkdocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ repo_url: https://github.com/InfoMusCP/PyEyesWeb
33
site_url: https://infomuscp.github.io/PyEyesWeb/
44

55
plugins:
6+
- search
7+
- macros
68
- gen-files:
79
scripts:
810
- docs/scripts/gen_pages.py
@@ -38,7 +40,7 @@ markdown_extensions:
3840
generic: true
3941

4042
theme:
41-
name: material
43+
name: readthedocs
4244
custom_dir: docs/overrides
4345
logo: assets/eyesweb-logo.png
4446
favicon: assets/favicon-32x32.png
@@ -86,8 +88,6 @@ extra_javascript:
8688
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
8789

8890
extra:
89-
version:
90-
provider: mike
9191
social:
9292
- icon: fontawesome/brands/github
9393
link: https://github.com/InfoMusCP

0 commit comments

Comments
 (0)