docs: split API docs into multiple documents

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

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

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

docs/api/session.rst

@@ -0,0 +1,5 @@
+Session
+-------
+
+.. autoclass:: streamlink.session.Streamlink
+    :member-order: bysource

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

docs/api/streamlink.rst

@@ -0,0 +1,4 @@
+Streamlink
+----------
+
+.. autofunction:: streamlink.streams

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 <api:Streams>` to see which attributes are available
+:ref:`Stream subclasses <api/stream:Streams>` to see which attributes are available
 for inspection for each stream type.
 
 For example, this is a :py:class:`HLSStream <streamlink.stream.HLSStream>` object which

docs/deprecations.rst

@@ -87,7 +87,7 @@ streamlink 3.0.0
 Removal of separate https-proxy option
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-:ref:`HTTPS proxy CLI option <cli:HTTP options>` and the respective :ref:`Session options <api:Session>`
+:ref:`HTTPS proxy CLI option <cli:HTTP options>` and the respective :ref:`Session options <api/session:Session>`
 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 <cli:Stream transport options>` and the respective :ref:`Session options <api:Session>`
-have been deprecated in favor of existing generic arguments/options, to avoid redundancy and potential confusion.
+:ref:`Stream-type related CLI arguments <cli:Stream transport options>` and the respective
+:ref:`Session options <api/session:Session>` 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``