Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

possibly use httpdomain for our api docs #674

Closed
wants to merge 1 commit into from

2 participants

@andymckay
Owner

api team, is this easier?

@wraithan

r+, we'll have to change some other stuff over to this in solitude and such.

@andymckay
Owner

hmm rtd is failing even though its meant to run requirements/docs.txt

@andymckay andymckay closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Mar 15, 2013
  1. @andymckay
This page is out of date. Refresh to see the latest.
View
3  docs/conf.py
@@ -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']
View
37 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
View
1  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
View
2  requirements/prod.txt
@@ -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
@@ -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
Something went wrong with that request. Please try again.