Skip to content

Commit f8342ae

Browse files
alexarjeclaude
andcommitted
Fourteen modules had no documentation page, seven of them since 1.15.0
Every module in this package gets an API-reference page rendered from its docstrings, and fourteen did not have one: the seven released today in 1.17.0, and seven more merged from action-segmentation and released in 1.15.0 without anyone noticing --- _actions, _hierarchy, _tracks, _timeline, _annotate, _select and _voice. The docstrings were already the thorough part; what was missing was the two lines that make them reachable. They are now a section of their own in the nav, since a segmentation and annotation workflow uses them together, and each page carries a line saying whether it is the page you want. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 3ea6851 commit f8342ae

16 files changed

Lines changed: 105 additions & 6 deletions

‎docs/MODULES.md‎

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,28 @@ Each page is rendered from the source docstrings by
66

77
- [Package overview](musicalgestures/index.md)
88
- [360video](musicalgestures/_360video.md)
9+
- [Actions](musicalgestures/_actions.md)
910
- [Alignment](musicalgestures/_alignment.md)
1011
- [Analysis](musicalgestures/_analysis.md)
1112
- [Anglegram](musicalgestures/_anglegram.md)
12-
- [Audio](musicalgestures/_audio.md)
13+
- [Annotate](musicalgestures/_annotate.md)
14+
- [Annotation views](musicalgestures/_views.md)
1315
- [Audio Video](musicalgestures/_audio_video.md)
16+
- [Audio](musicalgestures/_audio.md)
1417
- [Audiofeatures](musicalgestures/_audiofeatures.md)
1518
- [Blend](musicalgestures/_blend.md)
1619
- [Blurfaces](musicalgestures/_blurfaces.md)
1720
- [CenterFace](musicalgestures/_centerface.md)
21+
- [Cli](musicalgestures/cli.md)
22+
- [Co-accentuation](musicalgestures/_coaccentuation.md)
23+
- [Co-occurrence](musicalgestures/_cooccurrence.md)
1824
- [Colored](musicalgestures/_colored.md)
25+
- [Correlate](musicalgestures/_correlate.md)
1926
- [Cropping Window](musicalgestures/_cropping_window.md)
2027
- [Cropvideo](musicalgestures/_cropvideo.md)
2128
- [Dataset](musicalgestures/_dataset.md)
2229
- [Directograms](musicalgestures/_directograms.md)
30+
- [ELAN import](musicalgestures/_elan.md)
2331
- [Enums](musicalgestures/_enums.md)
2432
- [Eulerian](musicalgestures/_eulerian.md)
2533
- [Exceptions](musicalgestures/_exceptions.md)
@@ -29,10 +37,12 @@ Each page is rendered from the source docstrings by
2937
- [Frameaverage](musicalgestures/_frameaverage.md)
3038
- [Grid](musicalgestures/_grid.md)
3139
- [Heatmap](musicalgestures/_heatmap.md)
40+
- [Hierarchy](musicalgestures/_hierarchy.md)
3241
- [History](musicalgestures/_history.md)
3342
- [Impacts](musicalgestures/_impacts.md)
3443
- [Info](musicalgestures/_info.md)
3544
- [Input Test](musicalgestures/_input_test.md)
45+
- [Laughter](musicalgestures/_laughter.md)
3646
- [Logging](musicalgestures/_logging.md)
3747
- [MgList](musicalgestures/_mglist.md)
3848
- [Mocap](musicalgestures/_mocap.md)
@@ -45,30 +55,34 @@ Each page is rendered from the source docstrings by
4555
- [Peaks](musicalgestures/_peaks.md)
4656
- [Physio](musicalgestures/_physio.md)
4757
- [Pipeline](musicalgestures/_pipeline.md)
58+
- [Pose Visualize](musicalgestures/_pose_visualize.md)
4859
- [Pose](musicalgestures/_pose.md)
4960
- [PoseEstimator](musicalgestures/_pose_estimator.md)
50-
- [Pose Visualize](musicalgestures/_pose_visualize.md)
5161
- [Posetools](musicalgestures/_posetools.md)
5262
- [Posture](musicalgestures/_posture.md)
5363
- [Pulse](musicalgestures/_pulse.md)
5464
- [Qom](musicalgestures/_qom.md)
5565
- [Remap360](musicalgestures/_remap360.md)
56-
- [Show](musicalgestures/_show.md)
66+
- [Select](musicalgestures/_select.md)
5767
- [Show Window](musicalgestures/_show_window.md)
68+
- [Show](musicalgestures/_show.md)
5869
- [Sonification](musicalgestures/_sonification.md)
5970
- [Soundscape](musicalgestures/_soundscape.md)
6071
- [Spacetime](musicalgestures/_spacetime.md)
6172
- [Ssm](musicalgestures/_ssm.md)
6273
- [Stream](musicalgestures/_stream.md)
6374
- [Subtract](musicalgestures/_subtract.md)
6475
- [Sync](musicalgestures/_sync.md)
76+
- [Test Dance](musicalgestures/examples/test_dance.md)
77+
- [Test Pianist](musicalgestures/examples/test_pianist.md)
6578
- [Timecode](musicalgestures/_timecode.md)
79+
- [Timeline](musicalgestures/_timeline.md)
80+
- [Tracks](musicalgestures/_tracks.md)
6681
- [Utils](musicalgestures/_utils.md)
6782
- [Video](musicalgestures/_video.md)
6883
- [Videoadjust](musicalgestures/_videoadjust.md)
6984
- [Videograms](musicalgestures/_videograms.md)
7085
- [Videoreader](musicalgestures/_videoreader.md)
86+
- [Voice](musicalgestures/_voice.md)
7187
- [Warp](musicalgestures/_warp.md)
72-
- [Cli](musicalgestures/cli.md)
73-
- [Test Dance](musicalgestures/examples/test_dance.md)
74-
- [Test Pianist](musicalgestures/examples/test_pianist.md)
88+
- [Zoomable page](musicalgestures/_zoomview.md)

‎docs/musicalgestures/_actions.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Actions
2+
3+
Cutting a motion envelope into spans, and keeping segmentation apart from recognition.
4+
5+
::: musicalgestures._actions

‎docs/musicalgestures/_annotate.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Annotate
2+
3+
ELAN, TextGrid and TSV export, and reading an .eaf back.
4+
5+
::: musicalgestures._annotate
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Co-accentuation
2+
3+
Whether motion accents land on sound accents, judged against a chance baseline.
4+
5+
::: musicalgestures._coaccentuation
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Co-occurrence
2+
3+
Which annotation layers coincide, and by how much.
4+
5+
::: musicalgestures._cooccurrence

‎docs/musicalgestures/_correlate.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Correlate
2+
3+
Correlation across a lag range, with a multiple-comparison correction and an effective sample size.
4+
5+
::: musicalgestures._correlate

‎docs/musicalgestures/_elan.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# ELAN import
2+
3+
Reading ELAN's exported text, keeping the provenance line that names the media.
4+
5+
::: musicalgestures._elan

‎docs/musicalgestures/_hierarchy.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Hierarchy
2+
3+
Named levels of Action and the containment between them.
4+
5+
::: musicalgestures._hierarchy

‎docs/musicalgestures/_laughter.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Laughter
2+
3+
Where laughter probably is, shipped as proposals because it was measured first.
4+
5+
::: musicalgestures._laughter

‎docs/musicalgestures/_select.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Select
2+
3+
Choosing a defensible sample of spans rather than the ones that look best.
4+
5+
::: musicalgestures._select

0 commit comments

Comments
 (0)