From 52eefa4c1240cefe715d1bac6d91f03db8802b95 Mon Sep 17 00:00:00 2001 From: Adrian Chaves Date: Thu, 25 Jun 2026 08:42:25 +0200 Subject: [PATCH] =?UTF-8?q?client/=20=E2=86=92=20use/,=20ref/?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/conf.py | 7 ++++++- docs/index.rst | 4 ++-- docs/quickstart.rst | 4 ++-- docs/{client => ref}/apidocs.rst | 2 ++ docs/requirements.in | 1 + docs/requirements.txt | 3 +++ docs/{client => use}/overview.rst | 2 ++ 7 files changed, 18 insertions(+), 5 deletions(-) rename docs/{client => ref}/apidocs.rst (98%) rename docs/{client => use}/overview.rst (99%) diff --git a/docs/conf.py b/docs/conf.py index 61181de9..6be469ea 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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'] diff --git a/docs/index.rst b/docs/index.rst index 3a6b7122..2c435968 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 672d409e..7f2f1a0c 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -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 diff --git a/docs/client/apidocs.rst b/docs/ref/apidocs.rst similarity index 98% rename from docs/client/apidocs.rst rename to docs/ref/apidocs.rst index e83f5c0f..f210845e 100644 --- a/docs/client/apidocs.rst +++ b/docs/ref/apidocs.rst @@ -1,3 +1,5 @@ +.. _api-reference: + API Reference ============= diff --git a/docs/requirements.in b/docs/requirements.in index a97eaea5..536c0aff 100644 --- a/docs/requirements.in +++ b/docs/requirements.in @@ -1,2 +1,3 @@ +sphinx-reredirects sphinx-rtd-theme sphinx-scrapy @ git+https://github.com/scrapy/sphinx-scrapy.git@0.7.1 diff --git a/docs/requirements.txt b/docs/requirements.txt index 8dda1b27..394f6bfe 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -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 @@ -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 diff --git a/docs/client/overview.rst b/docs/use/overview.rst similarity index 99% rename from docs/client/overview.rst rename to docs/use/overview.rst index 1bb7b1f2..528ad213 100644 --- a/docs/client/overview.rst +++ b/docs/use/overview.rst @@ -1,3 +1,5 @@ +.. _overview: + Overview ========