Skip to content

Commit 1f0bb34

Browse files
committed
chore: Fix class links in supported-formats.rst
1 parent 5a68da2 commit 1f0bb34

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/supported-formats.rst

+10-10
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ and vector graphics.
2525
- .ass files (Advanced SubStation Alpha v4.0+), format identifier is ``"ass"``.
2626
- .ssa files (SubStation Alpha v4.0), format identifier is ``"ssa"``.
2727

28-
Implemented in :class:`pysubs2.substation.SubstationFormat`.
28+
Implemented in :class:`pysubs2.formats.substation.SubstationFormat`.
2929

3030
.. versionchanged:: 1.2.0
3131
Added support for embedded fonts. Fonts in loaded files will be preserved on save.
@@ -43,7 +43,7 @@ SubRip (SRT)
4343

4444
This format uses .srt files, format identifier is ``"srt"``. Widely used subtitle format, it uses HTML
4545
tags for formatting, though it is usually not heavily formatted (as opposed to *SubStation*).
46-
Implemented in :class:`pysubs2.subrip.SubripFormat`.
46+
Implemented in :class:`pysubs2.formats.subrip.SubripFormat`.
4747

4848
.. versionchanged:: 1.4.0
4949
Added option to keep SubStation override tags in SRT output. This is useful if your SRT file uses
@@ -58,7 +58,7 @@ MPL2
5858

5959
Time-based format similar to MicroDVD, format identifier is ``"mpl2"``. To save subtitles in MPL2 format,
6060
use ``subs.save("subtitles.txt", format_="mpl2")``.
61-
Implemented in :class:`pysubs2.mpl2.MPL2Format`.
61+
Implemented in :class:`pysubs2.formats.mpl2.MPL2Format`.
6262

6363
.. versionchanged:: 0.2.2
6464
Added support for MPL2 subtitle format.
@@ -69,7 +69,7 @@ TMP
6969
Time-based format, format identifier is ``"tmp"``. A very simple format which only specifies starting time
7070
for each subtitle, eg. ``0:00:13:This is a subtitle``. Subtitle length is calculated automatically based on character
7171
count. This older subtitle format is also referred to as "TMP Player" format.
72-
Implemented in :class:`pysubs2.tmp.TmpFormat`.
72+
Implemented in :class:`pysubs2.formats.tmp.TmpFormat`.
7373

7474
.. versionchanged:: 0.2.4
7575
Added support for TMP subtitle format.
@@ -81,7 +81,7 @@ Time-based format similar to SubRip, format identifier is ``"vtt"``. Currently i
8181
as a flavour of SubRip, with no extra support for WebVTT-specific features like styles or subtitle alignment.
8282
`Link to WebVTT specification <https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API>`_, official name is
8383
"Web Video Text Tracks Format".
84-
Implemented in :class:`pysubs2.webvtt.WebVTTFormat`.
84+
Implemented in :class:`pysubs2.formats.webvtt.WebVTTFormat`.
8585

8686
.. versionchanged:: 1.0.0
8787
Added basic support for WebVTT subtitle format.
@@ -94,7 +94,7 @@ which is currently not supported at all by the parser, but there is some support
9494

9595
`Link to TTML specification <https://www.w3.org/TR/ttml1>`_, official name is
9696
"Timed Text Markup Language 1".
97-
Implemented in :class:`pysubs2.ttml.TTMLFormat`.
97+
Implemented in :class:`pysubs2.formats.ttml.TTMLFormat`.
9898

9999
.. versionchanged:: 1.8.0
100100
Added basic support for TTML subtitle format.
@@ -108,7 +108,7 @@ for this format.
108108
`Link to SAMI 1.0 specification <https://learn.microsoft.com/en-us/previous-versions/windows/desktop/dnacc/understanding-sami-1.0>`_,
109109
official name is "Synchronized Accessible Media Interchange".
110110

111-
Implemented in :class:`pysubs2.sami.SAMIFormat`.
111+
Implemented in :class:`pysubs2.formats.sami.SAMIFormat`.
112112

113113
.. versionchanged:: 1.8.0
114114
Added basic support for SAMI subtitle format.
@@ -119,7 +119,7 @@ OpenAI Whisper
119119
Time-based format for transcriptions generated from `Whisper JAX <https://huggingface.co/spaces/sanchit-gandhi/whisper-jax>`_,
120120
format identifier is ``"whisper_jax"``. Only parser is implemented.
121121

122-
Implemented in :class:`pysubs2.whisper.WhisperJAXFormat`.
122+
Implemented in :class:`pysubs2.formats.whisper.WhisperJAXFormat`.
123123

124124
.. versionchanged:: 1.8.0
125125
Added support for parsing text representation of Whisper JAX output (previously,
@@ -135,7 +135,7 @@ MicroDVD
135135
This format uses .sub files, format identifier is ``"microdvd"``. This format uses frames to describe start/end times,
136136
instead of hour/minute/second, which means it is dependent on framerate of the video. For proper retiming and conversion,
137137
you need to know the framerate (sometimes it is given in the first subtitle, which ``pysubs2`` will autodetect and use).
138-
Implemented in :class:`pysubs2.microdvd.MicroDVDFormat`.
138+
Implemented in :class:`pysubs2.formats.microdvd.MicroDVDFormat`.
139139

140140
Other
141141
-----
@@ -144,7 +144,7 @@ JSON
144144
~~~~
145145

146146
This is JSON-serialized internal representation, which amounts to ASS. Format identifier is ``"json"``.
147-
Implemented in :class:`pysubs2.jsonformat.JSONFormat`.
147+
Implemented in :class:`pysubs2.formats.jsonformat.JSONFormat`.
148148

149149
OpenAI Whisper (API)
150150
~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)