diff options
| author | Stephen Finucane <stephen@that.guru> | 2017-04-26 22:45:33 +0100 |
|---|---|---|
| committer | Stephen Finucane <stephen@that.guru> | 2017-04-26 23:07:44 +0100 |
| commit | c565029962be8f812555c6f9d782a5053e0e3942 (patch) | |
| tree | 14f6a63eee3ef7e7d5701334fed36aaf647f86dd /docs/index.rst | |
| parent | 86887e9eb250dc971535b3637446f0fd83470753 (diff) | |
| download | patchwork-c565029962be8f812555c6f9d782a5053e0e3942.tar patchwork-c565029962be8f812555c6f9d782a5053e0e3942.tar.gz | |
docs: Split API docs into their own section
Third time lucky. There are two changes:
- Add a new 'clients' section to the usage doc, allowing us to remove a
lot of the API nitty gritty stuff from the users guide. This makes
more sense as users don't really care what API method they're using -
only what application).
- Change the API docs from the developers guide into a quick start
section, allowing us to greatly expand the REST API docs to include
information on pagination, authentication, etc.
Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/docs/index.rst b/docs/index.rst index 27e55ac..29f2c9d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -27,8 +27,7 @@ of community projects. usage/design usage/delegation usage/headers - usage/rest - usage/xmlrpc + usage/clients .. _deployment-docs: @@ -39,7 +38,7 @@ of community projects. deployment/installation deployment/upgrading -.. development-docs: +.. _development-docs: .. toctree:: :maxdepth: 2 @@ -48,8 +47,16 @@ of community projects. development/contributing development/installation development/releasing - development/rest - development/xmlrpc + development/api + +.. _api-docs: + +.. toctree:: + :maxdepth: 2 + :caption: API Documentation + + api/rest + api/xmlrpc .. _release-note-docs: |