Skip to content

Commit a4d0439

Browse files
committed
[docs] Give better names to documentation sections in TOC
1 parent 4bbe0ae commit a4d0439

File tree

8 files changed

+8
-14
lines changed

8 files changed

+8
-14
lines changed

docs/api.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,11 @@ Module Reference
9696
:name: fullapitoc
9797

9898
api/detectors
99-
api/backends
10099
api/scene_manager
100+
api/common
101101
api/video_splitter
102+
api/backends
102103
api/stats_manager
103-
api/common
104104
api/detector
105105
api/video_stream
106106
api/platform

docs/api/backends.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.. _scenedetect-backends:
33

44
----------------------------------------
5-
Backends
5+
Input Backends
66
----------------------------------------
77

88
.. automodule:: scenedetect.backends

docs/api/common.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.. _scenedetect-common:
33

44
---------------------------------------------------------------
5-
Common
5+
Common Types
66
---------------------------------------------------------------
77

88
.. automodule:: scenedetect.common

docs/api/detector.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.. _scenedetect-detector:
33

44
-------------------------------------------------
5-
Detector
5+
Detector Interface
66
-------------------------------------------------
77

88
.. automodule:: scenedetect.detector

docs/api/scene_manager.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.. _scenedetect-scene_manager:
33

44
-----------------------------------------------------------------------
5-
SceneManager
5+
Scene Manager
66
-----------------------------------------------------------------------
77

88
.. automodule:: scenedetect.scene_manager

docs/api/stats_manager.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.. _scenedetect-stats_manager:
33

44
-----------------------------------------------------------------------
5-
StatsManager
5+
Stats Manager
66
-----------------------------------------------------------------------
77

88
.. automodule:: scenedetect.stats_manager

docs/api/video_stream.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
.. _scenedetect-video_stream:
33

44
---------------------------------------------------------------
5-
VideoStream
5+
Stream Interface
66
---------------------------------------------------------------
77

88
.. automodule:: scenedetect.video_stream

scenedetect/common.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,6 @@
1818
timecode, allowing a frame number to be converted to/from a floating-point number of seconds, or
1919
string in the form `"HH:MM:SS[.nnn]"` where the `[.nnn]` part is optional.
2020
21-
See the following examples, or the :class:`FrameTimecode constructor <FrameTimecode>`.
22-
23-
===============================================================
24-
Usage Examples
25-
===============================================================
26-
2721
A :class:`FrameTimecode` can be created by specifying a timecode (`int` for number of frames,
2822
`float` for number of seconds, or `str` in the form "HH:MM:SS" or "HH:MM:SS.nnn") with a framerate:
2923

0 commit comments

Comments
 (0)