adding a basic geo example

Mike Dirolf · Mike Dirolf · commit 78716ea3b276 · 2010-03-22T14:04:37.000-04:00
diff --git a/doc/examples/geo.rst b/doc/examples/geo.rst
@@ -0,0 +1,82 @@
+Geospatial Indexing Example
+===========================
+
+.. testsetup::
+
+  from pymongo import Connection
+  connection = Connection()
+  connection.drop_database('geo_example')
+
+This example shows how to create and use a :data:`~pymongo.GEO2D`
+index in PyMongo.
+
+.. note:: 2D indexes require server version **>= 1.3.4**. Support for
+   2D indexes also requires PyMongo version **>= 1.5.1**.
+
+.. mongodoc:: geo
+
+Creating a Geospatial Index
+---------------------------
+
+Creating a geospatial index in pymongo is easy:
+
+.. doctest::
+
+  >>> from pymongo import Connection, GEO2D
+  >>> db = Connection().geo_example
+  >>> db.places.create_index([("loc", GEO2D)])
+  u'loc_2d'
+
+Inserting Places
+----------------
+
+Locations in MongoDB are represented using either embedded documents
+or lists where the first two elements are coordinates. Here, we'll
+insert a couple of example locations:
+
+.. doctest::
+
+  >>> db.places.insert({"loc": [2, 5]})
+  ObjectId('...')
+  >>> db.places.insert({"loc": [30, 5]})
+  ObjectId('...')
+  >>> db.places.insert({"loc": [1, 2]})
+  ObjectId('...')
+  >>> db.places.insert({"loc": [4, 4]})
+  ObjectId('...')
+
+Querying
+--------
+
+Using the geospatial index we can find documents near another point:
+
+.. doctest::
+
+  >>> for doc in db.places.find({"loc": {"$near": [3, 6]}}).limit(3):
+  ...   repr(doc)
+  ...
+  "{u'loc': [2, 5], u'_id': ObjectId('...')}"
+  "{u'loc': [4, 4], u'_id': ObjectId('...')}"
+  "{u'loc': [1, 2], u'_id': ObjectId('...')}"
+
+It's also possible to query for all items within a given rectangle
+(specified by lower-left and upper-right coordinates):
+
+.. doctest::
+
+  >>> for doc in db.places.find({"loc": {"$within": {"$box": [[2, 2], [5, 6]]}}}):
+  ...   repr(doc)
+  ...
+  "{u'loc': [4, 4], u'_id': ObjectId('...')}"
+  "{u'loc': [2, 5], u'_id': ObjectId('...')}"
+
+Or circle (specified by center point and radius):
+
+.. doctest::
+
+  >>> for doc in db.places.find({"loc": {"$within": {"$center": [[0, 0], 6]}}}):
+  ...   repr(doc)
+  ...
+  "{u'loc': [1, 2], u'_id': ObjectId('...')}"
+  "{u'loc': [2, 5], u'_id': ObjectId('...')}"
+  "{u'loc': [4, 4], u'_id': ObjectId('...')}"
diff --git a/doc/examples/index.rst b/doc/examples/index.rst
@@ -18,4 +18,5 @@ MongoDB, you can start it like so:
 
    gridfs
    map_reduce
+   geo
    custom_type
diff --git a/doc/mongo_extensions.py b/doc/mongo_extensions.py
@@ -70,9 +70,14 @@ def process_mongodoc_nodes(app, doctree, fromdocname):
     env = app.builder.env
 
     for node in doctree.traverse(mongodoc):
+        anchor = None
         for name in node.parent.parent.traverse(addnodes.desc_signature):
             anchor = name["ids"][0]
             break
+        if not anchor:
+            for name in node.parent.traverse(nodes.section):
+                anchor = name["ids"][0]
+                break
         for para in node.traverse(nodes.paragraph):
             tag = str(para.traverse()[1])
             link = mongoref("", "")
