Skip to content
This repository has been archived by the owner on Mar 15, 2018. It is now read-only.

possibly use httpdomain for our api docs #674

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/conf.py
Expand Up @@ -25,7 +25,8 @@
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
'sphinx.ext.intersphinx', 'sphinx.ext.todo',
'sphinx.ext.coverage', 'extensions.src_role']
'sphinx.ext.coverage', 'extensions.src_role',
'sphinxcontrib.httpdomain']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
37 changes: 37 additions & 0 deletions docs/topics/api/reviewers.rst
@@ -0,0 +1,37 @@
.. _reviewers:

=============
Reviewers API
=============

Reviewing
=========

.. note:: Requires authentication and permission to review apps.

.. http:get:: /api/reviewers/reviewing/

Returns a list of apps that are being reviewed.

**Request**:

.. sourcecode:: http

GET /api/reviewers/reviewing/ HTTP/1.1

**Response**:

.. sourcecode:: http

{
"meta": {
"previous": None, ...
},
"objects': [
{
"resource_uri": "/api/apps/app/337141/"
}
]
}

:statuscode 200: no error
1 change: 1 addition & 0 deletions requirements/docs.txt
@@ -1,6 +1,7 @@
# For buildings docs (also used by RTD)
-r prod.txt

sphinxcontrib-httpdomain==1.1.7
docutils==0.9.1
Pygments==1.5
Sphinx==1.1.3
2 changes: 0 additions & 2 deletions requirements/prod.txt
Expand Up @@ -34,7 +34,6 @@ django-session-csrf==0.5
django-statsd-mozilla==0.3.8.6
django-storages==1.1.4
django-tastypie==0.9.11
docutils==0.7
easy-thumbnails==1.1
elasticutils==0.5
fastchardet==0.2.0
Expand Down Expand Up @@ -75,7 +74,6 @@ requests==0.14.0
schematic==0.2
signing_clients==0.1.3
slumber==0.5.3
Sphinx==0.6.3
SQLAlchemy==0.7.5
statsd==1.0.0
suds==0.3.9
Expand Down