diff options
| author | Ben Sturmfels <ben@sturm.com.au> | 2020-04-29 09:55:28 +1000 |
|---|---|---|
| committer | Ben Sturmfels <ben@sturm.com.au> | 2020-04-29 09:55:28 +1000 |
| commit | 464a5d7fba1888667eb1c68a7777d69003c62314 (patch) | |
| tree | 84d73cd976ef3958eb35637d20cfa8ee569903de /docs/source/api | |
| parent | 35494ed66c1ee380e9331fc3a81fd6ade4c897ff (diff) | |
| download | mediagoblin-464a5d7fba1888667eb1c68a7777d69003c62314.tar.lz mediagoblin-464a5d7fba1888667eb1c68a7777d69003c62314.tar.xz mediagoblin-464a5d7fba1888667eb1c68a7777d69003c62314.zip | |
Fix some docs build warnings.
Diffstat (limited to 'docs/source/api')
| -rw-r--r-- | docs/source/api/activities.rst | 2 | ||||
| -rw-r--r-- | docs/source/api/authentication.rst | 10 | ||||
| -rw-r--r-- | docs/source/api/objects.rst | 2 |
3 files changed, 7 insertions, 7 deletions
diff --git a/docs/source/api/activities.rst b/docs/source/api/activities.rst index cbbd1fab..b3828c34 100644 --- a/docs/source/api/activities.rst +++ b/docs/source/api/activities.rst @@ -83,7 +83,7 @@ to represent "albums" or collections of media however they can represent anythin be used in the future to represent lists/groups of users which you can send activities to. Example -^^^^^^^ +------- A collection which contains two images:: { diff --git a/docs/source/api/authentication.rst b/docs/source/api/authentication.rst index 2db4a7bd..860783e3 100644 --- a/docs/source/api/authentication.rst +++ b/docs/source/api/authentication.rst @@ -53,7 +53,7 @@ redirect_uri Response -^^^^^^^^ +-------- You will get back a response: @@ -67,10 +67,10 @@ expires_at This is time that the client credentials expire. If this is 0 the client registration does not expire. Examples --------- +~~~~~~~~ Register Client -^^^^^^^^^^^^^^^ +--------------- To register a client for the first time, this is the minimum you must supply:: @@ -89,7 +89,7 @@ A Response will look like:: Updating Client -^^^^^^^^^^^^^^^ +--------------- Using the response we got above we can update the information and add new information we may have opted not to supply:: @@ -113,7 +113,7 @@ The response will just return back the client_id and client_secret you sent:: Possible Registration Errors ----------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ There are a number of errors you could get back, This explains what could cause some of them: diff --git a/docs/source/api/objects.rst b/docs/source/api/objects.rst index 854febe1..dcb68090 100644 --- a/docs/source/api/objects.rst +++ b/docs/source/api/objects.rst @@ -11,7 +11,7 @@ Dedication along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. -.. info:: Currently only image uploading is supported. +.. note:: Currently only image uploading is supported. ======= Objects |