Reorganize Streaming documentation

diff --git a/docs/getting_started.rst b/docs/getting_started.rst
index 3a3ea1cfb11576681aeed9d9973b56783d8122c2..b1e0552d37c35710eba5ac24b025300f10de24b1 100644 (file)
--- a/docs/getting_started.rst
+++ b/docs/getting_started.rst
@@ -64,3 +64,33 @@ The :ref:`authentication` page goes into more detail.
 
 More examples can be found on the :ref:`examples` page.
 
+Streaming
+=========
+
+Streams utilize Streaming HTTP protocol to deliver data through
+an open, streaming API connection. Rather than delivering data in batches
+through repeated requests by your client app, as might be expected from a REST
+API, a single connection is opened between your app and the API, with new
+results being sent through that connection whenever new matches occur. This
+results in a low-latency delivery mechanism that can support very high
+throughput. For further information, see
+https://developer.twitter.com/en/docs/tutorials/consuming-streaming-data
+
+The Twitter API v1.1 streaming endpoints, `statuses/filter`_ and
+`statuses/sample`_, have been deprecated and retired.
+
+.. note::
+
+    ``Stream`` and ``AsyncStream`` were deprecated in v4.13 and removed with
+    v4.14.
+
+:class:`StreamingClient` allows `filtering <v2 filtering_>`_ and
+`sampling <v2 sampling_>`_ of realtime Tweets using Twitter API v2.
+
+.. _statuses/filter: https://twittercommunity.com/t/announcing-the-deprecation-of-v1-1-statuses-filter-endpoint/182960
+.. _statuses/sample: https://twittercommunity.com/t/deprecation-announcement-removing-compliance-messages-from-statuses-filter-and-retiring-statuses-sample-from-the-twitter-api-v1-1/170500
+.. _v2 filtering: https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/introduction
+.. _v2 sampling: https://developer.twitter.com/en/docs/twitter-api/tweets/volume-streams/introduction
+
+The :ref:`streaming_guide` page goes into more detail.
+

diff --git a/docs/index.rst b/docs/index.rst
index 5d7f0c3a3c2505d51bb462f6b8ee0f5497a1c473..3e02cbf8bbaf6c6239bfa76ad1d3c5052696f03c 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -15,7 +15,6 @@ Contents:
    getting_started.rst
    authentication.rst
    logging.rst
-   streaming.rst
 
 .. toctree::
    :caption: Twitter API v1.1 Reference
@@ -40,6 +39,7 @@ Contents:
    expansions_and_fields.rst
    v2_models.rst
    v2_pagination.rst
+   streaming.rst
 
 .. toctree::
    :caption: Meta

diff --git a/docs/streaming.rst b/docs/streaming.rst
index d359e35a2116cb0b4b4f5f4cc6d2f8d5e27d5fd9..5e8654e792ea122974e093c5a15b56095f114089 100644 (file)
--- a/docs/streaming.rst
+++ b/docs/streaming.rst
@@ -6,31 +6,6 @@
 Streaming
 *********
 
-Streams utilize Streaming HTTP protocol to deliver data through
-an open, streaming API connection. Rather than delivering data in batches
-through repeated requests by your client app, as might be expected from a REST
-API, a single connection is opened between your app and the API, with new
-results being sent through that connection whenever new matches occur. This
-results in a low-latency delivery mechanism that can support very high
-throughput. For further information, see
-https://developer.twitter.com/en/docs/tutorials/consuming-streaming-data
-
-The Twitter API v1.1 streaming endpoints, `statuses/filter`_ and
-`statuses/sample`_, have been deprecated and retired.
-
-.. note::
-
-    ``Stream`` and ``AsyncStream`` were deprecated in v4.13 and removed with
-    v4.14.
-
-:class:`StreamingClient` allows `filtering <v2 filtering_>`_ and
-`sampling <v2 sampling_>`_ of realtime Tweets using Twitter API v2.
-
-.. _statuses/filter: https://twittercommunity.com/t/announcing-the-deprecation-of-v1-1-statuses-filter-endpoint/182960
-.. _statuses/sample: https://twittercommunity.com/t/deprecation-announcement-removing-compliance-messages-from-statuses-filter-and-retiring-statuses-sample-from-the-twitter-api-v1-1/170500
-.. _v2 filtering: https://developer.twitter.com/en/docs/twitter-api/tweets/filtered-stream/introduction
-.. _v2 sampling: https://developer.twitter.com/en/docs/twitter-api/tweets/volume-streams/introduction
-
 Using :class:`StreamingClient`
 ==============================