Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add LED patterns to LED documentation #2774

Open
wants to merge 25 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
897a7e8
Start adding LED patterns to LED documentation
SamCarlberg Oct 8, 2024
a4d4589
Start adding sections for factories and modifiers
SamCarlberg Oct 9, 2024
87940af
Add documentation for modifier effects
SamCarlberg Oct 10, 2024
e521d02
Correct C++ relative scroll speed
SamCarlberg Oct 11, 2024
1cb2b31
Update combinatory effects
SamCarlberg Oct 11, 2024
fb18cfb
Add .webm files for LED animations
SamCarlberg Oct 12, 2024
4f8a1d3
Add sphinxcontrib-video for video embeds
SamCarlberg Oct 12, 2024
e075fe1
Replace .gif elements with .webm
SamCarlberg Oct 12, 2024
1be4406
Merge branch 'main' into led-patterns
SamCarlberg Oct 12, 2024
4e83eb0
Remove ignore from inspector.json
SamCarlberg Oct 12, 2024
a700aa5
Change RLIs to point to version tag; set image widths; fix posters
SamCarlberg Oct 12, 2024
ebaa63d
Fix typo
SamCarlberg Oct 12, 2024
d482954
Replace webm with mp4
SamCarlberg Oct 12, 2024
abb38ee
Prevent video elements from exceeding the bounds of the main panel
SamCarlberg Oct 12, 2024
d312ea6
Remove note on the single AddressableLED object
SamCarlberg Oct 20, 2024
3418b57
Move units note to rainbow section
SamCarlberg Oct 20, 2024
31cae2b
Move clock sync note to base section and fix typo
SamCarlberg Oct 20, 2024
a4281e1
Merge branch 'main' into led-patterns
SamCarlberg Oct 20, 2024
e5fab23
Move low-level access to the bottom
SamCarlberg Oct 20, 2024
4a4dbc3
Add section on using commands for controlling pattern lifetimes
SamCarlberg Oct 20, 2024
8d6e87b
Click videos to toggle play/pause
SamCarlberg Oct 31, 2024
f06606c
Only render videos in HTML build
SamCarlberg Oct 31, 2024
d826930
Fall back to static pngs instead of gifs
SamCarlberg Oct 31, 2024
5c1ca87
Autofix RLIs
invalid-email-address Nov 2, 2024
16777bb
Merge branch 'main' into led-patterns
SamCarlberg Nov 3, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/inspector.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@
"latestVersion":"6a5b6352807a8759bd0f012e57695c47f7ef7324"
}
],
"ignoredFiles": ["source/docs/software/commandbased/command-scheduler.rst", "source/docs/software/hardware-apis/pneumatics/pressure.rst", "source/docs/software/hardware-apis/pneumatics/solenoids.rst", "source/docs/software/advanced-controls/state-space/state-space-pose-estimators.rst", "source/docs/software/commandbased/profilepid-subsystems-commands.rst", "source/docs/software/commandbased/subsystems.rst", "source/docs/software/telemetry/writing-sendable-classes.rst", "source/docs/software/advanced-controls/trajectories/troubleshooting.rst", "source/docs/software/hardware-apis/motors/wpi-drive-classes.rst", "source/docs/software/pathplanning/trajectory-tutorial/creating-drive-subsystem.rst", "source/docs/software/pathplanning/trajectory-tutorial/creating-following-trajectory.rst", "source/docs/software/pathplanning/trajectory-tutorial/entering-constants.rst", "source/docs/software/convenience-features/event-based.rst", "source/docs/software/dashboards/glass/field2d-widget.rst", "source/docs/software/dashboards/smartdashboard/choosing-an-autonomous-program-from-smartdashboard.rst", "source/docs/software/hardware-apis/misc/addressable-leds.rst"]
"ignoredFiles": ["source/docs/software/commandbased/command-scheduler.rst", "source/docs/software/hardware-apis/pneumatics/pressure.rst", "source/docs/software/hardware-apis/pneumatics/solenoids.rst", "source/docs/software/advanced-controls/state-space/state-space-pose-estimators.rst", "source/docs/software/commandbased/profilepid-subsystems-commands.rst", "source/docs/software/commandbased/subsystems.rst", "source/docs/software/telemetry/writing-sendable-classes.rst", "source/docs/software/advanced-controls/trajectories/troubleshooting.rst", "source/docs/software/hardware-apis/motors/wpi-drive-classes.rst", "source/docs/software/pathplanning/trajectory-tutorial/creating-drive-subsystem.rst", "source/docs/software/pathplanning/trajectory-tutorial/creating-following-trajectory.rst", "source/docs/software/pathplanning/trajectory-tutorial/entering-constants.rst", "source/docs/software/convenience-features/event-based.rst", "source/docs/software/dashboards/glass/field2d-widget.rst", "source/docs/software/dashboards/smartdashboard/choosing-an-autonomous-program-from-smartdashboard.rst"]
}
49 changes: 41 additions & 8 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ modern-sphinx-version-warning = "==1.1.6"
sphinxcontrib-htmlhelp = "==2.1.0"
sphinxcontrib-serializinghtml = "==2.0.0"
sphinxcontrib-svg2pdfconverter = "==1.2.2"
sphinxcontrib-video = "==0.2.1"
sphinxext-delta = "==0.2.0"
sphinxext-mimic = "==0.1.1"
sphinxext-opengraph = "==0.9.0"
Expand Down
9 changes: 9 additions & 0 deletions source/_static/css/frc-rtd.css
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,15 @@
width: 320px;
}

/*
* Prevent video containers from spilling over the edges of the main panel.
* This matches the built-in style for `.rst-content img`
*/
.rst-content video {
max-width: 100%;
height: auto;
}

.document img {
margin-bottom: 10px;
}
Expand Down
1 change: 1 addition & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
"sphinx.ext.autosectionlabel",
"sphinx.ext.intersphinx",
"sphinxcontrib.rsvgconverter",
"sphinxcontrib.video",
"sphinxext.delta",
"sphinxext.opengraph",
"sphinxext.photofinish",
Expand Down
Loading
Loading