Skip to content
Merged
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
7 changes: 6 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,12 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx_scrapy']
extensions = ['sphinx_scrapy', 'sphinx_reredirects']

redirects = {
"client/overview": "../use/overview.html",
"client/apidocs": "../ref/apidocs.html",
}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ The ``scrapinghub`` is a Python library for communicating with the `Scrapinghub
:caption: Usage
:maxdepth: 1

client/overview
use/overview

.. toctree::
:caption: Reference
:maxdepth: 1

client/apidocs
ref/apidocs

.. toctree::
:caption: Legacy
Expand Down
4 changes: 2 additions & 2 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ Access your job's output data::
}
...

Checkout all the other features in :doc:`client/overview` or in the more
detailed :doc:`client/apidocs`.
Checkout all the other features in :ref:`overview` or in the more
detailed :ref:`api-reference`.


.. _MessagePack: https://en.wikipedia.org/wiki/MessagePack
2 changes: 2 additions & 0 deletions docs/client/apidocs.rst → docs/ref/apidocs.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _api-reference:

API Reference
=============

Expand Down
1 change: 1 addition & 0 deletions docs/requirements.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
sphinx-reredirects
sphinx-rtd-theme
sphinx-scrapy @ git+https://github.com/scrapy/sphinx-scrapy.git@0.7.1
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ sphinx==9.1.0
# sphinx-copybutton
# sphinx-llms-txt
# sphinx-markdown-builder
# sphinx-reredirects
# sphinx-rtd-theme
# sphinx-scrapy
# sphinxcontrib-jquery
Expand All @@ -47,6 +48,8 @@ sphinx-llms-txt @ git+https://github.com/zytedata/sphinx-llms-txt.git@5e8866cb0c
# via sphinx-scrapy
sphinx-markdown-builder @ git+https://github.com/zytedata/sphinx-markdown-builder.git@ac9f8babfe622e4300099ab44b96d9d9228e742e
# via sphinx-scrapy
sphinx-reredirects==1.1.0
# via -r requirements.in
sphinx-rtd-theme==3.1.0
# via -r requirements.in
sphinx-scrapy @ git+https://github.com/scrapy/sphinx-scrapy.git@2b5f6c7de64c8317cb771fdeb2e5020d1c9c9dcf
Expand Down
2 changes: 2 additions & 0 deletions docs/client/overview.rst → docs/use/overview.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _overview:

Overview
========

Expand Down
Loading