Skip to content

Commit bdd4222

Browse files
committed
[docs] Fix listing hidden items
1 parent 7fa9a25 commit bdd4222

File tree

2 files changed

+34
-1
lines changed

2 files changed

+34
-1
lines changed

docs/cli.rst

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Options
8181

8282
.. option:: -b BACKEND, --backend BACKEND
8383

84-
Backend to use for video input. Backend options can be set using a config file (:option:`-c/--config <-c>`). [available: opencv, pyav]
84+
Backend to use for video input. Backend options can be set using a config file (:option:`-c/--config <-c>`). [available: opencv, pyav, moviepy]
8585

8686
Default: ``opencv``
8787

@@ -800,6 +800,38 @@ Options
800800
.. program:: scenedetect save-xml
801801

802802

803+
``save-xml``
804+
========================================================================
805+
806+
[IN DEVELOPMENT] Save cuts in XML format.
807+
808+
809+
Options
810+
------------------------------------------------------------------------
811+
812+
813+
.. option:: -f NAME, --filename NAME
814+
815+
Filename format to use.
816+
817+
Default: ``$VIDEO_NAME.xml``
818+
819+
.. option:: --format TYPE
820+
821+
Format to export. TYPE must be one of: fcpx, fcp.
822+
823+
Default: ``XmlFormat.FCPX``
824+
825+
.. option:: -o DIR, --output DIR
826+
827+
Output directory to save XML file to. Overrides global option :option:`-o/--output <scenedetect -o>`.
828+
829+
830+
.. _command-split-video:
831+
832+
.. program:: scenedetect split-video
833+
834+
803835
``split-video``
804836
========================================================================
805837

docs/generate_cli_docs.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,7 @@ def create_help() -> ty.Tuple[str, ty.List[str]]:
252252
ctx = click.Context(scenedetect, info_name=scenedetect.name)
253253

254254
commands: ty.List[str] = ctx.command.list_commands(ctx)
255+
commands = list(filter(lambda command: not ctx.command.hidden, commands))
255256
# ctx.to_info_dict lacks metavar so we have to use the context directly.
256257
actions = [
257258
generate_title("``scenedetect`` 🎬 Command", level=0),

0 commit comments

Comments
 (0)