diff options
| author | Stephen Finucane <stephen@that.guru> | 2018-10-27 01:39:38 +0100 |
|---|---|---|
| committer | Stephen Finucane <stephen@that.guru> | 2019-01-29 09:35:08 +0000 |
| commit | f825f207e91c2bf88e802e81cdfb1ee72114b2db (patch) | |
| tree | 75fca72cd94ff8fc0f8dfdb5b2084bfb40796115 /docs/api | |
| parent | 4031719e10b7d979e59303f0f9335c60e0c98af3 (diff) | |
| download | patchwork-f825f207e91c2bf88e802e81cdfb1ee72114b2db.tar patchwork-f825f207e91c2bf88e802e81cdfb1ee72114b2db.tar.gz | |
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>
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/index.rst | 2 | ||||
| -rw-r--r-- | docs/api/rest/index.rst (renamed from docs/api/rest.rst) | 7 | ||||
| -rw-r--r-- | docs/api/xmlrpc.rst | 2 |
3 files changed, 6 insertions, 5 deletions
diff --git a/docs/api/index.rst b/docs/api/index.rst index 8248150..c679dae 100644 --- 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 index 6b11ac7..befd709 100644 --- 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 374df96..5412cce 100644 --- 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 --------------- |