docs: Move REST API guide to subfolder

We're going to dramatically expand these docs, so let's set up room to
do so.

This shouldn't break any links as we're using 'htmldir' output on
ReadTheDocs.

Signed-off-by: Stephen Finucane <stephen@that.guru>

diff --git a/docs/api/index.rst b/docs/api/index.rst
index 8248150906c2099101d57fc5dc8bed5c7c7775c2..c679dae133bf214d8fcb60987bb21839146869cb 100644 (file)
--- a/docs/api/index.rst
+++ b/docs/api/index.rst
@@ -10,5 +10,5 @@ release.
 .. toctree::
    :maxdepth: 2
 
-   /api/rest
+   /api/rest/index
    /api/xmlrpc

diff --git a/docs/api/rest.rst b/docs/api/rest/index.rst
similarity index 97%
rename from docs/api/rest.rst
rename to docs/api/rest/index.rst
index 6b11ac77c7a0630e69166fdad9c74aa2a829de8e..befd709e2795ee8417f03c768115ffd6bbe36c55 100644 (file)
--- a/docs/api/rest.rst
+++ b/docs/api/rest/index.rst
@@ -23,7 +23,8 @@ where `patchwork.example.com` refers to the URL of your Patchwork instance.
 .. versionadded:: 2.0
 
    The REST API was introduced in Patchwork v2.0. Users of earlier Patchwork
-   versions should instead refer to :doc:`XML-RPC API <xmlrpc>` documentation.
+   versions should instead refer to :doc:`XML-RPC API </api/xmlrpc>`
+   documentation.
 
 .. versionchanged:: 2.1
 
@@ -81,14 +82,14 @@ well-supported. To repeat the above example using `requests`:, run
 
 Tools like `curl` and libraries like `requests` can be used to build anything
 from small utilities to full-fledged clients targeting the REST API. For an
-overview of existing API clients, refer to :doc:`../usage/clients`.
+overview of existing API clients, refer to :doc:`/usage/clients`.
 
 .. tip::
 
     While you can do a lot with existing installations, it's possible that you
     might not have access to all resources or may not wish to modify any
     existing resources. In this case, it might be better to :doc:`deploy your
-    own instance of Patchwork locally <../development/installation>` and
+    own instance of Patchwork locally </development/installation>` and
     experiment with that instead.
 
 Versioning

diff --git a/docs/api/xmlrpc.rst b/docs/api/xmlrpc.rst
index 374df964861bc0c9b03c12125cd9d27fb8b0e82e..5412cce5d1558d63d819cc0ee385653f5eb53a12 100644 (file)
--- a/docs/api/xmlrpc.rst
+++ b/docs/api/xmlrpc.rst
@@ -17,7 +17,7 @@ and modify information about patches, projects and more.
 .. deprecated:: 2.0
 
     The XML-RPC API is a legacy API and has been deprecated in favour of the
-    :doc:`REST API <rest>`. It will be removed in Patchwork 3.0.
+    :doc:`REST API <rest/index>`. It will be removed in Patchwork 3.0.
 
 Getting Started
 ---------------

diff --git a/docs/deployment/configuration.rst b/docs/deployment/configuration.rst
index 0601276a3cbcc44a27f411311cdf0509305e9f54..ba9a2ebc8c97687b279607abf9de9e077d40801e 100644 (file)
--- a/docs/deployment/configuration.rst
+++ b/docs/deployment/configuration.rst
@@ -78,7 +78,7 @@ Enable the :doc:`XML-RPC API <../api/xmlrpc>`.
 ``ENABLE_REST_API``
 ~~~~~~~~~~~~~~~~~~~
 
-Enable the :doc:`REST API <../api/rest>`.
+Enable the :doc:`REST API <../api/rest/index>`.
 
 .. versionadded:: 2.0
 

diff --git a/docs/development/api.rst b/docs/development/api.rst
index bcb1f695739497a07c62dea68cd4af262615749b..cea7bc78dd55ecbb259841f54aec481f4710e316 100644 (file)
--- a/docs/development/api.rst
+++ b/docs/development/api.rst
@@ -3,10 +3,10 @@
 Using the APIs
 ==============
 
-Patchwork provides two APIs: the legacy :doc:`XML-RPC API <../api/xmlrpc>` and
-the :doc:`REST API <../api/rest>`. You can use these APIs to interact with
+Patchwork provides two APIs: the legacy :doc:`XML-RPC API </api/xmlrpc>` and
+the :doc:`REST API </api/rest/index>`. You can use these APIs to interact with
 Patchwork programmatically and to develop your own clients.
 
 For quick usage examples of the APIs, refer to the :doc:`documentation
 <../api/index>`. For examples of existing clients, refer to
-:doc:`../usage/clients`.
+:doc:`/usage/clients`.

diff --git a/docs/index.rst b/docs/index.rst
index 0de5f76d1ff80471fb070c3607078531d94b006a..b73c647c522256ec7cbf145ba78110911e7d94cf 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -50,7 +50,7 @@ of community projects.
    :maxdepth: 2
    :caption: API Documentation
 
-   api/rest
+   api/rest/index
    api/xmlrpc
 
 .. toctree::