From ba74acc36ed2db07a32b62b71bf6083c8eef83b4 Mon Sep 17 00:00:00 2001 From: Adrian Chaves Date: Thu, 23 Jul 2026 11:07:12 +0200 Subject: [PATCH] Split the Quickstart page into Installation and Basic usage --- docs/conf.py | 1 + docs/index.rst | 3 ++- docs/{quickstart.rst => intro/basic.rst} | 27 +----------------------- docs/intro/install.rst | 23 ++++++++++++++++++++ 4 files changed, 27 insertions(+), 27 deletions(-) rename docs/{quickstart.rst => intro/basic.rst} (84%) create mode 100644 docs/intro/install.rst diff --git a/docs/conf.py b/docs/conf.py index 6be469ea..d3889c1e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,6 +42,7 @@ extensions = ['sphinx_scrapy', 'sphinx_reredirects'] redirects = { + "quickstart": "intro/install.html", "client/overview": "../use/overview.html", "client/apidocs": "../ref/apidocs.html", } diff --git a/docs/index.rst b/docs/index.rst index 2c435968..bad073b8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,8 @@ The ``scrapinghub`` is a Python library for communicating with the `Scrapinghub :caption: Getting started :maxdepth: 1 - quickstart + intro/install + intro/basic .. toctree:: :caption: Usage diff --git a/docs/quickstart.rst b/docs/intro/basic.rst similarity index 84% rename from docs/quickstart.rst rename to docs/intro/basic.rst index 1cd1cd80..de8bd94c 100644 --- a/docs/quickstart.rst +++ b/docs/intro/basic.rst @@ -1,27 +1,5 @@ -Quickstart -========== - -Requirements ------------- - -* Python 3.10+ - - -Installation ------------- - -The quick way:: - - pip install scrapinghub - -It is recommended to install the library with `MessagePack`_ support, -it provides better response time and improved bandwidth usage:: - - pip install scrapinghub[msgpack] - - Basic usage ------------ +=========== Instantiate a new client with your Scrapy Cloud API key:: @@ -86,6 +64,3 @@ Access your job's output data:: Checkout all the other features in :ref:`overview` or in the more detailed :ref:`api-reference`. - - -.. _MessagePack: https://en.wikipedia.org/wiki/MessagePack diff --git a/docs/intro/install.rst b/docs/intro/install.rst new file mode 100644 index 00000000..6dcd1b95 --- /dev/null +++ b/docs/intro/install.rst @@ -0,0 +1,23 @@ +Installation +============ + +Requirements +------------ + +* Python 3.10+ + + +Installing scrapinghub +---------------------- + +The quick way:: + + pip install scrapinghub + +It is recommended to install the library with `MessagePack`_ support, +it provides better response time and improved bandwidth usage:: + + pip install scrapinghub[msgpack] + + +.. _MessagePack: https://en.wikipedia.org/wiki/MessagePack