Skip to content

Commit 8755b4f

Browse files
committed
[docs] Fix emitting docs for hidden commands
1 parent 3569572 commit 8755b4f

File tree

3 files changed

+4
-80
lines changed

3 files changed

+4
-80
lines changed

docs/api/output.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,14 @@
22

33
.. _scenedetect-output:
44

5-
---------------------------------------------------------------
5+
-------------------------------------------------
66
Ouptut
7-
---------------------------------------------------------------
7+
-------------------------------------------------
88

99
.. automodule:: scenedetect.output
1010
:members:
1111

12-
.. autofunction:: scenedetect.output.image.save_images
13-
14-
---------------------------------------------------------------
15-
Video
16-
---------------------------------------------------------------
12+
.. autofunction:: scenedetect.output.save_images
1713

1814
.. automodule:: scenedetect.output.video
1915
:members:

docs/cli.rst

Lines changed: 0 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -432,46 +432,6 @@ Commands
432432
************************************************************************
433433

434434

435-
.. _command-save-html:
436-
437-
.. program:: scenedetect save-html
438-
439-
440-
``save-html``
441-
========================================================================
442-
443-
Save scene list to HTML file.
444-
445-
To customize image generation, specify the :ref:`save-images <command-save-images>` command before :ref:`save-html <command-save-html>`. This command always uses the result of the preceeding :ref:`save-images <command-save-images>` command, or runs it with the default config values unless ``--no-images`` is set.
446-
447-
448-
Options
449-
------------------------------------------------------------------------
450-
451-
452-
.. option:: -f NAME, --filename NAME
453-
454-
Filename format to use for the scene list HTML file. You can use the $VIDEO_NAME macro in the file name. Note that you may have to wrap the format name using single quotes.
455-
456-
Default: ``$VIDEO_NAME-Scenes.html``
457-
458-
.. option:: -n, --no-images
459-
460-
Do not include images with the result.
461-
462-
.. option:: -w pixels, --image-width pixels
463-
464-
Width in pixels of the images in the resulting HTML table.
465-
466-
.. option:: -h pixels, --image-height pixels
467-
468-
Height in pixels of the images in the resulting HTML table.
469-
470-
.. option:: -s, --show
471-
472-
Automatically open resulting HTML when processing is complete.
473-
474-
475435
.. _command-list-scenes:
476436

477437
.. program:: scenedetect list-scenes
@@ -795,38 +755,6 @@ Options
795755
Disable shifting frame numbers by start time.
796756

797757

798-
.. _command-save-xml:
799-
800-
.. program:: scenedetect save-xml
801-
802-
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-
830758
.. _command-split-video:
831759

832760
.. program:: scenedetect split-video

docs/generate_cli_docs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +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))
255+
commands = list(filter(lambda command: not ctx.command.get_command(ctx, command).hidden, commands))
256256
# ctx.to_info_dict lacks metavar so we have to use the context directly.
257257
actions = [
258258
generate_title("``scenedetect`` 🎬 Command", level=0),

0 commit comments

Comments
 (0)