diff --git a/docs/api.rst b/docs/api.rst index a399f775..a4c8f30e 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,97 +1,12 @@ API Reference ============= -This is a reference of all the available API methods in Streamlink. +This is an incomplete reference of the relevant Streamlink APIs. +.. toctree:: -Streamlink ------------- - -.. autofunction:: streamlink.streams - - -Session -------- - -.. autoclass:: streamlink.Streamlink - :member-order: bysource - - -Plugins -------- - -Plugin -^^^^^^ - -.. module:: streamlink.plugin - -.. autoclass:: Plugin - :private-members: _get_streams - :member-order: bysource - -Plugin decorators -^^^^^^^^^^^^^^^^^ - -.. autodecorator:: pluginmatcher - -.. autodecorator:: pluginargument - -Plugin arguments -^^^^^^^^^^^^^^^^ - -.. module:: streamlink.options - -.. autoclass:: Argument - -.. autoclass:: Arguments - - -Streams -------- - -.. module:: streamlink.stream - -All streams inherit from the :class:`Stream` class. - -Stream -^^^^^^ - -.. autoclass:: Stream - -MuxedStream -^^^^^^^^^^^ - -.. autoclass:: MuxedStream - -HTTPStream -^^^^^^^^^^ - -.. autoclass:: HTTPStream - -HLSStream -^^^^^^^^^ - -.. autoclass:: HLSStream - -MuxedHLSStream -^^^^^^^^^^^^^^ - -.. autoclass:: MuxedHLSStream - -DASHStream -^^^^^^^^^^ - -.. autoclass:: DASHStream - - -Exceptions ----------- - -Streamlink has multiple types of exceptions: - -.. autoexception:: streamlink.exceptions.StreamlinkError -.. autoexception:: streamlink.exceptions.PluginError -.. autoexception:: streamlink.exceptions.FatalPluginError -.. autoexception:: streamlink.exceptions.NoPluginError -.. autoexception:: streamlink.exceptions.NoStreamsError -.. autoexception:: streamlink.exceptions.StreamError + api/streamlink + api/session + api/plugin + api/stream + api/exceptions diff --git a/docs/api/exceptions.rst b/docs/api/exceptions.rst new file mode 100644 index 00000000..60951e84 --- /dev/null +++ b/docs/api/exceptions.rst @@ -0,0 +1,9 @@ +Exceptions +---------- + +.. autoexception:: streamlink.exceptions.StreamlinkError +.. autoexception:: streamlink.exceptions.PluginError +.. autoexception:: streamlink.exceptions.FatalPluginError +.. autoexception:: streamlink.exceptions.NoPluginError +.. autoexception:: streamlink.exceptions.NoStreamsError +.. autoexception:: streamlink.exceptions.StreamError diff --git a/docs/api/plugin.rst b/docs/api/plugin.rst new file mode 100644 index 00000000..20806cca --- /dev/null +++ b/docs/api/plugin.rst @@ -0,0 +1,24 @@ +Plugin +------ + +.. module:: streamlink.plugin + +.. autoclass:: Plugin + :private-members: _get_streams + :member-order: bysource + +Plugin decorators +^^^^^^^^^^^^^^^^^ + +.. autodecorator:: pluginmatcher + +.. autodecorator:: pluginargument + +Plugin arguments +^^^^^^^^^^^^^^^^ + +.. module:: streamlink.options + +.. autoclass:: Argument + +.. autoclass:: Arguments diff --git a/docs/api/session.rst b/docs/api/session.rst new file mode 100644 index 00000000..4c85bede --- /dev/null +++ b/docs/api/session.rst @@ -0,0 +1,5 @@ +Session +------- + +.. autoclass:: streamlink.session.Streamlink + :member-order: bysource diff --git a/docs/api/stream.rst b/docs/api/stream.rst new file mode 100644 index 00000000..00dc39bb --- /dev/null +++ b/docs/api/stream.rst @@ -0,0 +1,36 @@ +Streams +------- + +.. module:: streamlink.stream + +All streams inherit from the :class:`Stream` class. + +Stream +^^^^^^ + +.. autoclass:: Stream + +MuxedStream +^^^^^^^^^^^ + +.. autoclass:: MuxedStream + +HTTPStream +^^^^^^^^^^ + +.. autoclass:: HTTPStream + +HLSStream +^^^^^^^^^ + +.. autoclass:: HLSStream + +MuxedHLSStream +^^^^^^^^^^^^^^ + +.. autoclass:: MuxedHLSStream + +DASHStream +^^^^^^^^^^ + +.. autoclass:: DASHStream diff --git a/docs/api/streamlink.rst b/docs/api/streamlink.rst new file mode 100644 index 00000000..8598eeaf --- /dev/null +++ b/docs/api/streamlink.rst @@ -0,0 +1,4 @@ +Streamlink +---------- + +.. autofunction:: streamlink.streams diff --git a/docs/api_guide.rst b/docs/api_guide.rst index cc8c7801..bcfafee5 100644 --- a/docs/api_guide.rst +++ b/docs/api_guide.rst @@ -58,7 +58,7 @@ Inspecting streams ------------------ It's also possible to inspect the stream's internal parameters. Go to -:ref:`Stream subclasses ` to see which attributes are available +:ref:`Stream subclasses ` to see which attributes are available for inspection for each stream type. For example, this is a :py:class:`HLSStream ` object which diff --git a/docs/deprecations.rst b/docs/deprecations.rst index 2d618f50..418c390d 100644 --- a/docs/deprecations.rst +++ b/docs/deprecations.rst @@ -87,7 +87,7 @@ streamlink 3.0.0 Removal of separate https-proxy option ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:ref:`HTTPS proxy CLI option ` and the respective :ref:`Session options ` +:ref:`HTTPS proxy CLI option ` and the respective :ref:`Session options ` have been deprecated in favor of a single :option:`--http-proxy` that sets the proxy for all HTTP and HTTPS requests, including WebSocket connections. @@ -98,8 +98,9 @@ streamlink 2.4.0 Stream-type related CLI arguments ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:ref:`Stream-type related CLI arguments ` and the respective :ref:`Session options ` -have been deprecated in favor of existing generic arguments/options, to avoid redundancy and potential confusion. +:ref:`Stream-type related CLI arguments ` and the respective +:ref:`Session options ` have been deprecated in favor of existing generic arguments/options, +to avoid redundancy and potential confusion. - use :option:`--stream-segment-attempts` instead of ``--{dash,hds,hls}-segment-attempts`` - use :option:`--stream-segment-threads` instead of ``--{dash,hds,hls}-segment-threads``