dochub links

Author: Mike Dirolf

doc/mongo_extensions.py

@@ -82,7 +82,6 @@ def process_mongodoc_nodes(app, doctree, fromdocname):
             new_para = nodes.paragraph()
             new_para += link
             node.replace(para, new_para)
-        break
 
 
 def setup(app):

gridfs/__init__.py

@@ -16,6 +16,8 @@
 
 The :mod:`gridfs` package is an implementation of GridFS on top of
 :mod:`pymongo`, exposing a file-like interface.
+
+.. mongodoc:: gridfs
 """
 
 from gridfs.grid_file import GridFile
@@ -32,6 +34,8 @@ def __init__(self, database):
 
         :Parameters:
           - `database`: database to use
+
+        .. mongodoc:: gridfs
         """
         if not isinstance(database, Database):
             raise TypeError("database must be an instance of Database")

pymongo/collection.py

@@ -49,6 +49,8 @@ def __init__(self, database, name, options=None):
           - `options`: dictionary of collection options.  see
             :meth:`~pymongo.database.Database.create_collection` for
             details.
+
+        .. mongodoc:: collections
         """
         if not isinstance(name, basestring):
             raise TypeError("name must be an instance of basestring")
@@ -169,6 +171,8 @@ def save(self, to_save, manipulate=True, safe=False):
           - `to_save`: the SON object to be saved
           - `manipulate` (optional): manipulate the SON object before saving it
           - `safe` (optional): check that the save succeeded?
+
+        .. mongodoc:: insert
         """
         if not isinstance(to_save, dict):
             raise TypeError("cannot save object of type %s" % type(to_save))
@@ -201,6 +205,8 @@ def insert(self, doc_or_docs,
 
         .. versionchanged:: 1.1
            Bulk insert works with any iterable
+
+        .. mongodoc:: insert
         """
         docs = doc_or_docs
         if isinstance(docs, dict):
@@ -275,6 +281,8 @@ def update(self, spec, document,
 
         .. _update modifiers: http://www.mongodb.org/display/DOCS/Updating
         .. _upsert: http://www.mongodb.org/display/DOCS/Updating#Updating-Upserts
+
+        .. mongodoc:: update
         """
         if not isinstance(spec, dict):
             raise TypeError("spec must be an instance of dict")
@@ -328,6 +336,8 @@ def remove(self, spec_or_object_id=None, safe=False):
            removed.
         .. versionadded:: 1.1
            The `safe` parameter.
+
+        .. mongodoc:: remove
         """
         spec = spec_or_object_id
         if spec is None:
@@ -511,6 +521,8 @@ def create_index(self, key_or_list, unique=False, ttl=300):
         .. seealso:: :meth:`ensure_index`
 
         .. _compound index: http://www.mongodb.org/display/DOCS/Indexes#Indexes-CompoundKeysIndexes
+
+        .. mongodoc:: indexes
         """
         if not isinstance(key_or_list, (str, unicode, list)):
             raise TypeError("key_or_list must either be a single key "
@@ -774,6 +786,8 @@ def map_reduce(self, map, reduce, full_response=False, **kwargs):
         .. versionadded:: 1.2
 
         .. _map reduce command: http://www.mongodb.org/display/DOCS/MapReduce
+
+        .. mongodoc:: mapreduce
         """
         command = SON([("mapreduce", self.__name),
                        ("map", map), ("reduce", reduce)])

pymongo/connection.py

@@ -132,6 +132,8 @@ def __init__(self, host=None, port=None, pool_size=None,
            parameters.
         .. versionadded:: 1.1
            The `network_timeout` parameter.
+
+        .. mongodoc:: connections
         """
         if host is None:
             host = self.HOST

pymongo/cursor.py

@@ -42,6 +42,8 @@ def __init__(self, collection, spec, fields, skip, limit, slave_okay,
         """Create a new cursor.
 
         Should not be called directly by application developers.
+
+        .. mongodoc:: cursors
         """
         self.__collection = collection
         self.__spec = spec
@@ -166,6 +168,8 @@ def limit(self, limit):
 
         :Parameters:
           - `limit`: the number of results to return
+
+        .. mongodoc:: limit
         """
         if not isinstance(limit, int):
             raise TypeError("limit must be an int")
@@ -340,6 +344,8 @@ def distinct(self, key):
 
     def explain(self):
         """Returns an explain plan record for this cursor.
+
+        .. mongodoc:: explain
         """
         c = self.clone()
         c.__explain = True

pymongo/database.py

@@ -50,6 +50,8 @@ def __init__(self, connection, name):
           - `connection`: a :class:`~pymongo.connection.Connection`
             instance
           - `name`: database name
+
+        .. mongodoc:: databases
         """
         if not isinstance(name, basestring):
             raise TypeError("name must be an instance of basestring")
@@ -234,6 +236,8 @@ def command(self, command, check=True, allowable_errors=[], _sock=None):
         .. versionchanged:: 1.4+
            `command` can be a string in addition to a full document.
         .. versionadded:: 1.4
+
+        .. mongodoc:: commands
         """
 
         if isinstance(command, str):
@@ -308,6 +312,8 @@ def profiling_level(self):
 
         Returns one of (:data:`~pymongo.OFF`,
         :data:`~pymongo.SLOW_ONLY`, :data:`~pymongo.ALL`).
+
+        .. mongodoc:: profiling
         """
         result = self.command({"profile": -1})
 
@@ -323,6 +329,8 @@ def set_profiling_level(self, level):
 
         :Parameters:
           - `level`: the profiling level to use
+
+        .. mongodoc:: profiling
         """
         if not isinstance(level, int) or level < 0 or level > 2:
             raise ValueError("level must be one of (OFF, SLOW_ONLY, ALL)")
@@ -331,6 +339,8 @@ def set_profiling_level(self, level):
 
     def profiling_info(self):
         """Returns a list containing current profiling information.
+
+        .. mongodoc:: profiling
         """
         return list(self["system.profile"].find())
 
@@ -463,6 +473,8 @@ def authenticate(self, name, password):
         :Parameters:
           - `name`: the name of the user to authenticate
           - `password`: the password of the user to authenticate
+
+        .. mongodoc:: authenticate
         """
         if not isinstance(name, basestring):
             raise TypeError("name must be an instance of basestring")

pymongo/dbref.py

@@ -35,6 +35,8 @@ def __init__(self, collection, id, database=None):
 
         .. versionadded:: 1.1.1
            The `database` parameter.
+
+        .. mongodoc:: dbrefs
         """
         if not isinstance(collection, basestring):
             raise TypeError("collection must be an instance of basestring")

pymongo/objectid.py

@@ -68,6 +68,8 @@ def __init__(self, oid=None):
            hexadecimal digits).
 
         .. _ObjectId: http://www.mongodb.org/display/DOCS/Object+IDs
+
+        .. mongodoc:: objectids
         """
         if oid is None:
             self.__generate()