Skip to content

Commit

Permalink
Fixed refs, complied HTML
Browse files Browse the repository at this point in the history
  • Loading branch information
brousch committed Mar 20, 2013
1 parent ca405a9 commit ce57735
Show file tree
Hide file tree
Showing 34 changed files with 953 additions and 1,082 deletions.
2 changes: 1 addition & 1 deletion docs/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 9334b085b500e0ada775369d69869b63
config: e486eb93cce7797af9117eab10fdefc1
tags: fbb0d17656682115ca4d033fb2f83ba1
Binary file added docs/html/.doctrees/advanced.doctree
Binary file not shown.
Binary file added docs/html/.doctrees/api.doctree
Binary file not shown.
Binary file added docs/html/.doctrees/api_examples.doctree
Binary file not shown.
Binary file added docs/html/.doctrees/api_tools.doctree
Binary file not shown.
Binary file added docs/html/.doctrees/configure.doctree
Binary file not shown.
Binary file added docs/html/.doctrees/contribute.doctree
Binary file not shown.
Binary file added docs/html/.doctrees/customizing.doctree
Binary file not shown.
Binary file added docs/html/.doctrees/environment.pickle
Binary file not shown.
Binary file added docs/html/.doctrees/index.doctree
Binary file not shown.
Binary file added docs/html/.doctrees/install.doctree
Binary file not shown.
Binary file added docs/html/.doctrees/permissions.doctree
Binary file not shown.
Binary file added docs/html/.doctrees/settings.doctree
Binary file not shown.
Binary file added docs/html/.doctrees/subscribers.doctree
Binary file not shown.
Binary file added docs/html/.doctrees/upgrade.doctree
Binary file not shown.
Binary file added docs/html/_images/admin_apikey_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/html/_images/admin_apikey_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/html/_images/admin_apikey_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions docs/html/_sources/api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,12 @@ Delete
To delete an existing page, issue a DELETE to /api/page/[name].


More API Examples for Pages
~~~~~~~~~~~~~~~~~~~~~~~~~~~

:ref:`api_examples_page`


Files
-----

Expand Down Expand Up @@ -259,6 +265,11 @@ Delete
To delete an existing file, issue a DELETE to ``/api/file/[id]/``.


More API Examples for Files
~~~~~~~~~~~~~~~~~~~~~~~~~~~

:ref:`api_examples_file`


Maps
----
Expand Down Expand Up @@ -346,6 +357,12 @@ Delete
To delete an existing map, issue a DELETE to /api/map/[pagename].


More API Examples for Maps
~~~~~~~~~~~~~~~~~~~~~~~~~~~

:ref:`api_examples_map`


Tags
----

Expand Down Expand Up @@ -407,6 +424,13 @@ Delete

You cannot currently delete a tag.


More API Examples for Tags
~~~~~~~~~~~~~~~~~~~~~~~~~~~

:ref:`api_examples_tag`


Page Tags
---------

Expand Down
21 changes: 18 additions & 3 deletions docs/html/_sources/api_examples.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@
API Examples
============

.. _api_examples_page:

Page examples
-------------

Get all pages whose title end in "park", case-insensitive
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get all pages whose title ends in "park", case-insensitive
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``/api/page/?name__iendswith=park``

Expand Down Expand Up @@ -212,6 +214,14 @@ Let's find all versions of pages that were edited after June 25th, 2012 at 22:21
}


All pages tagged with [sometag]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``/api/page/?page_tags__tags__slug=sometag&format=json``


.. _api_examples_file:

File examples
-------------

Expand Down Expand Up @@ -254,6 +264,8 @@ We can retrieve the file itself by visiting the location specified in
the `file` attribute.


.. _api_examples_map:

Map examples
------------

Expand Down Expand Up @@ -635,10 +647,11 @@ With polygons within:
}


.. _api_examples_tag:

Tag examples
------------


Pages with a particular tag
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -845,6 +858,8 @@ Full detail:
}


.. _api_examples_redirect:

Redirect examples
-----------------

Expand Down
42 changes: 42 additions & 0 deletions docs/html/_sources/api_tools.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
=========
API Tools
=========

It should be easy to interact with the API using any standard HTTP
library.

We'll give some specific interaction examples here.


Python
------

If you're using Python, we recommend you check out the small and
simple `slumber <https://github.com/dstufft/slumber/>`_ library,
which makes it really easy to work with RESTful APIs like the LocalWiki API.
Here's some examples using slumber with the LocalWiki API::

import slumber
api = slumber.API('http://detroitwiki.org/api/')
username = 'myusername'
api_key = 'apikey'

# Get all pages
api.page.get()

# Find all pages whose page name starts with 'Detroit', case
# insensitive:
api.page.get(name__istartswith='detroit')

# Get detail about a particular, known page
api.page('Front Page')

# Create a new page
api.page.post({'name': 'My new page', 'content': '<p>Hello.</p>'},
username=username, api_key=api_key)


Ruby
----

Work has begun on a Ruby API client. Check it out at https://github.com/codeforseattle/localwiki_client. It's in a very early stage at this point, so you may want to help with its development!
Binary file added docs/html/_static/images/admin_apikey_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/html/_static/images/admin_apikey_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/html/_static/images/admin_apikey_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit ce57735

Please sign in to comment.