Skip to content

Commit 506082d

Browse files
committed
applet.video.ws2812_output: Add docs
1 parent 043d899 commit 506082d

File tree

4 files changed

+31
-1
lines changed

4 files changed

+31
-1
lines changed

docs/manual/src/applets/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,5 @@ Applet index
1616
sensor/index
1717
bridge/index
1818
audio/index
19+
video/index
1920
internal/index
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _applet.video:
2+
3+
Video capture and output
4+
========================
5+
6+
.. automodule:: glasgow.applet.video
7+
8+
.. toctree::
9+
:maxdepth: 3
10+
11+
ws2812_output
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
``video-ws2812-output``
2+
=======================
3+
4+
CLI reference
5+
-------------
6+
7+
.. _applet.video.ws2812_output:
8+
9+
.. autoprogram:: glasgow.applet.video.ws2812_output:VideoWS2812OutputApplet._get_argparser_for_sphinx("video-ws2812-output")
10+
:prog: glasgow run video-ws2812-output
11+
12+
13+
API reference
14+
-------------
15+
16+
.. module:: glasgow.applet.video.ws2812_output
17+
18+
.. autoclass:: VideoWS2812OutputInterface

software/glasgow/applet/video/ws2812_output/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ def add_build_arguments(cls, parser, access):
218218
help="set the number of LEDs per string")
219219
parser.add_argument(
220220
"-f", "--pix-fmt", metavar="F", choices=cls.pixel_formats.keys(), default="RGB-BRG",
221-
help="set the pixel format (one of: %(choices)s, default: %(default)s)")
221+
help="set the pixel format (default: %(default)s)")
222222
parser.add_argument(
223223
"-b", "--buffer", metavar="N", type=int, default=16,
224224
help="set the number of frames to buffer internally (buffered twice)")

0 commit comments

Comments
 (0)