Skip to content

Commit

Permalink
Update MongoAlchemy docs, .gitignore
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeff Jenkins committed Apr 9, 2011
1 parent 834290d commit 242ce55
Show file tree
Hide file tree
Showing 9 changed files with 153 additions and 5 deletions.
3 changes: 3 additions & 0 deletions .gitignore
@@ -1,4 +1,7 @@
docs/_*
MANIFEST
build/lib/
dist
*.pyc
*.swp
doctrees
Expand Down
Empty file.
4 changes: 2 additions & 2 deletions docs/build/html/api/schema/document.html
Expand Up @@ -72,7 +72,7 @@ <h3>Navigation</h3>
<h2><a class="reference internal" href="#mongoalchemy.document.Document" title="mongoalchemy.document.Document"><tt class="xref py py-class docutils literal"><span class="pre">Document</span></tt></a> Objects<a class="headerlink" href="#document-objects" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="mongoalchemy.document.Document">
<em class="property">class </em><tt class="descclassname">mongoalchemy.document.</tt><tt class="descname">Document</tt><big>(</big><em>retrieved_fields=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#mongoalchemy.document.Document" title="Permalink to this definition"></a></dt>
<em class="property">class </em><tt class="descclassname">mongoalchemy.document.</tt><tt class="descname">Document</tt><big>(</big><em>retrieved_fields=None</em>, <em>loading_from_db=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#mongoalchemy.document.Document" title="Permalink to this definition"></a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
Expand Down Expand Up @@ -362,7 +362,7 @@ <h4>Previous topic</h4>
title="previous chapter">Schema — Document-Object Mapper and Schema Definitions</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="fields.html"
title="next chapter"><tt class="docutils literal docutils literal"><span class="pre">fields</span></tt></a></p>
title="next chapter"><tt class="docutils literal"><span class="pre">fields</span></tt></a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/api/schema/document.txt"
Expand Down
45 changes: 44 additions & 1 deletion docs/build/html/api/schema/fields.html
Expand Up @@ -121,6 +121,11 @@ <h2>Field Objects<a class="headerlink" href="#field-objects" title="Permalink to
<dd><p>If this kind of field can have sub-fields, this attribute should be True</p>
</dd></dl>

<dl class="method">
<dt id="mongoalchemy.fields.Field.set_value">
<tt class="descname">set_value</tt><big>(</big><em>instance</em>, <em>value</em>, <em>from_db=False</em><big>)</big><a class="headerlink" href="#mongoalchemy.fields.Field.set_value" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="mongoalchemy.fields.Field.dirty_ops">
<tt class="descname">dirty_ops</tt><big>(</big><em>instance</em><big>)</big><a class="headerlink" href="#mongoalchemy.fields.Field.dirty_ops" title="Permalink to this definition"></a></dt>
Expand All @@ -147,6 +152,14 @@ <h2>Field Objects<a class="headerlink" href="#field-objects" title="Permalink to
in $in</p>
</dd></dl>

<dl class="method">
<dt id="mongoalchemy.fields.Field.set_parent_on_subtypes">
<tt class="descname">set_parent_on_subtypes</tt><big>(</big><em>parent</em><big>)</big><a class="headerlink" href="#mongoalchemy.fields.Field.set_parent_on_subtypes" title="Permalink to this definition"></a></dt>
<dd><p>This function sets the parent on any sub-Fields of this field. It
should be overridden by SequenceField and field which has subtypes
(such as SequenceField and DictField).</p>
</dd></dl>

<dl class="method">
<dt id="mongoalchemy.fields.Field.wrap">
<tt class="descname">wrap</tt><big>(</big><em>value</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#mongoalchemy.fields.Field.wrap" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -440,6 +453,11 @@ <h2>Primitive Fields<a class="headerlink" href="#primitive-fields" title="Permal
</tr>
</tbody>
</table>
<dl class="method">
<dt id="mongoalchemy.fields.TupleField.set_parent_on_subtypes">
<tt class="descname">set_parent_on_subtypes</tt><big>(</big><em>parent</em><big>)</big><a class="headerlink" href="#mongoalchemy.fields.TupleField.set_parent_on_subtypes" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="mongoalchemy.fields.TupleField.validate_wrap">
<tt class="descname">validate_wrap</tt><big>(</big><em>value</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#mongoalchemy.fields.TupleField.validate_wrap" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -509,6 +527,11 @@ <h2>Primitive Fields<a class="headerlink" href="#primitive-fields" title="Permal
</tr>
</tbody>
</table>
<dl class="method">
<dt id="mongoalchemy.fields.EnumField.set_parent_on_subtypes">
<tt class="descname">set_parent_on_subtypes</tt><big>(</big><em>parent</em><big>)</big><a class="headerlink" href="#mongoalchemy.fields.EnumField.set_parent_on_subtypes" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="mongoalchemy.fields.EnumField.validate_wrap">
<tt class="descname">validate_wrap</tt><big>(</big><em>value</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#mongoalchemy.fields.EnumField.validate_wrap" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -651,6 +674,11 @@ <h2>Sequence Type Fields<a class="headerlink" href="#sequence-type-fields" title
<dd><p>Returns True if the sequence&#8217;s value type has subfields.</p>
</dd></dl>

<dl class="method">
<dt id="mongoalchemy.fields.SequenceField.set_parent_on_subtypes">
<tt class="descname">set_parent_on_subtypes</tt><big>(</big><em>parent</em><big>)</big><a class="headerlink" href="#mongoalchemy.fields.SequenceField.set_parent_on_subtypes" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="mongoalchemy.fields.SequenceField.subfields">
<tt class="descname">subfields</tt><big>(</big><big>)</big><a class="headerlink" href="#mongoalchemy.fields.SequenceField.subfields" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -781,6 +809,11 @@ <h2>Mapping Type Fields<a class="headerlink" href="#mapping-type-fields" title="
</tr>
</tbody>
</table>
<dl class="method">
<dt id="mongoalchemy.fields.DictField.set_parent_on_subtypes">
<tt class="descname">set_parent_on_subtypes</tt><big>(</big><em>parent</em><big>)</big><a class="headerlink" href="#mongoalchemy.fields.DictField.set_parent_on_subtypes" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="mongoalchemy.fields.DictField.validate_unwrap">
<tt class="descname">validate_unwrap</tt><big>(</big><em>value</em>, <em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#mongoalchemy.fields.DictField.validate_unwrap" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -835,6 +868,11 @@ <h2>Mapping Type Fields<a class="headerlink" href="#mapping-type-fields" title="
<dd><p>If this kind of field can have sub-fields, this attribute should be True</p>
</dd></dl>

<dl class="method">
<dt id="mongoalchemy.fields.KVField.set_parent_on_subtypes">
<tt class="descname">set_parent_on_subtypes</tt><big>(</big><em>parent</em><big>)</big><a class="headerlink" href="#mongoalchemy.fields.KVField.set_parent_on_subtypes" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="mongoalchemy.fields.KVField.subfields">
<tt class="descname">subfields</tt><big>(</big><big>)</big><a class="headerlink" href="#mongoalchemy.fields.KVField.subfields" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -875,7 +913,7 @@ <h2>Mapping Type Fields<a class="headerlink" href="#mapping-type-fields" title="
<h2>Document Field Objects<a class="headerlink" href="#document-field-objects" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="mongoalchemy.document.DocumentField">
<em class="property">class </em><tt class="descclassname">mongoalchemy.document.</tt><tt class="descname">DocumentField</tt><big>(</big><em>document_class</em>, <em>namespace='global'</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#mongoalchemy.document.DocumentField" title="Permalink to this definition"></a></dt>
<em class="property">class </em><tt class="descclassname">mongoalchemy.document.</tt><tt class="descname">DocumentField</tt><big>(</big><em>document_class</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#mongoalchemy.document.DocumentField" title="Permalink to this definition"></a></dt>
<dd><p>A field which wraps a <tt class="xref py py-class docutils literal"><span class="pre">Document</span></tt></p>
<dl class="attribute">
<dt id="mongoalchemy.document.DocumentField.type">
Expand Down Expand Up @@ -989,6 +1027,11 @@ <h2>Computed Field Objects<a class="headerlink" href="#computed-field-objects" t
</tr>
</tbody>
</table>
<dl class="method">
<dt id="mongoalchemy.fields.ComputedField.set_parent_on_subtypes">
<tt class="descname">set_parent_on_subtypes</tt><big>(</big><em>parent</em><big>)</big><a class="headerlink" href="#mongoalchemy.fields.ComputedField.set_parent_on_subtypes" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="mongoalchemy.fields.ComputedField.dirty_ops">
<tt class="descname">dirty_ops</tt><big>(</big><em>instance</em><big>)</big><a class="headerlink" href="#mongoalchemy.fields.ComputedField.dirty_ops" title="Permalink to this definition"></a></dt>
Expand Down
92 changes: 92 additions & 0 deletions docs/build/html/examples/advanced_modeling.html
@@ -0,0 +1,92 @@


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>&lt;no title&gt; &mdash; MongoAlchemy v0.8 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="MongoAlchemy v0.8 documentation" href="../index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../index.html">MongoAlchemy v0.8 documentation</a> &raquo;</li>
</ul>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">



</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/examples/advanced_modeling.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../index.html">MongoAlchemy v0.8 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2010, Jeffrey Jenkins.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.3.
</div>
</body>
</html>
12 changes: 11 additions & 1 deletion docs/build/html/genindex.html
Expand Up @@ -379,11 +379,21 @@ <h2 id="S">S</h2>
<dt><a href="api/expressions/query.html#mongoalchemy.query.Query.set">set() (mongoalchemy.query.Query method)</a></dt>
<dd><dl>
<dt><a href="api/expressions/update_expressions.html#mongoalchemy.update_expression.UpdateExpression.set">(mongoalchemy.update_expression.UpdateExpression method)</a></dt>
</dl></dd>
<dt><a href="api/schema/fields.html#mongoalchemy.fields.ComputedField.set_parent_on_subtypes">set_parent_on_subtypes() (mongoalchemy.fields.ComputedField method)</a></dt>
<dd><dl>
<dt><a href="api/schema/fields.html#mongoalchemy.fields.DictField.set_parent_on_subtypes">(mongoalchemy.fields.DictField method)</a></dt>
<dt><a href="api/schema/fields.html#mongoalchemy.fields.EnumField.set_parent_on_subtypes">(mongoalchemy.fields.EnumField method)</a></dt>
<dt><a href="api/schema/fields.html#mongoalchemy.fields.Field.set_parent_on_subtypes">(mongoalchemy.fields.Field method)</a></dt>
<dt><a href="api/schema/fields.html#mongoalchemy.fields.KVField.set_parent_on_subtypes">(mongoalchemy.fields.KVField method)</a></dt>
<dt><a href="api/schema/fields.html#mongoalchemy.fields.SequenceField.set_parent_on_subtypes">(mongoalchemy.fields.SequenceField method)</a></dt>
<dt><a href="api/schema/fields.html#mongoalchemy.fields.TupleField.set_parent_on_subtypes">(mongoalchemy.fields.TupleField method)</a></dt>
</dl></dd>
<dt><a href="api/expressions/update_expressions.html#mongoalchemy.query.RemoveQuery.set_safe">set_safe() (mongoalchemy.query.RemoveQuery method)</a></dt>
<dt><a href="api/schema/fields.html#mongoalchemy.fields.SetField">SetField (class in mongoalchemy.fields)</a></dt>
<dt><a href="api/schema/fields.html#mongoalchemy.fields.Field.set_value">set_value() (mongoalchemy.fields.Field method)</a></dt>
</dl></td>
<td width="33%" valign="top"><dl>
<dt><a href="api/schema/fields.html#mongoalchemy.fields.SetField">SetField (class in mongoalchemy.fields)</a></dt>
<dt><a href="api/expressions/query.html#mongoalchemy.query.Query.skip">skip() (mongoalchemy.query.Query method)</a></dt>
<dt><a href="api/schema/fields.html#mongoalchemy.fields.StringField">StringField (class in mongoalchemy.fields)</a></dt>
<dt><a href="api/schema/fields.html#mongoalchemy.document.DocumentField.sub_type">sub_type() (mongoalchemy.document.DocumentField method)</a></dt>
Expand Down
Binary file modified docs/build/html/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js

Large diffs are not rendered by default.

Empty file.

0 comments on commit 242ce55

Please sign in to comment.