Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
extensions = ['sphinx_scrapy', 'sphinx_reredirects']

redirects = {
"quickstart": "intro/install.html",
"client/overview": "../use/overview.html",
"client/apidocs": "../ref/apidocs.html",
}
Expand Down
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
27 changes: 1 addition & 26 deletions docs/quickstart.rst → docs/intro/basic.rst
Original file line number Diff line number Diff line change
@@ -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::

Expand Down Expand Up @@ -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
23 changes: 23 additions & 0 deletions docs/intro/install.rst
Original file line number Diff line number Diff line change
@@ -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
Loading