Skip to content

Commit

Permalink
We'll need a page for buildable models too, I suppose. [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
@palewire
palewire committed Apr 1, 2014
1 parent d22d75f commit 9d6cc34
Show file tree
Hide file tree
Showing 14 changed files with 132 additions and 15 deletions.
Binary file added docs/_build/doctrees/buildablemodels.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/gettingstarted.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
View file
Binary file not shown.
2 changes: 2 additions & 0 deletions docs/_build/html/_sources/buildablemodels.txt
View file
@@ -0,0 +1,2 @@
Buildable models
================
2 changes: 1 addition & 1 deletion docs/_build/html/_sources/gettingstarted.txt
View file
Expand Up @@ -28,7 +28,7 @@ Also in ``settings.py``, add a build directory where the site will be built as f

The cru­cial step is to re­fact­or your views to in­her­it our :doc:`buildable class-based views </buildableviews>`. They are similar to Django's `generic class-based views <https://docs.djangoproject.com/en/dev/topics/class-based-views/>`_, except extended to know how to auto­mat­ic­ally build them­selves as flat files. Here is a list view and a de­tail view us­ing our sys­tem.

.. code-block:: python
.. code-block:: django

from yourapp.mod­els im­port Dummy­Mod­el
from bakery.views im­port Build­able­De­tailView, Build­ableL­istView
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/_sources/index.txt
View file
Expand Up @@ -11,6 +11,7 @@ Documentation

gettingstarted
buildableviews
buildablemodels
settingsvariables
managementcommands
celeryintegration
Expand Down
110 changes: 110 additions & 0 deletions docs/_build/html/buildablemodels.html
View file
@@ -0,0 +1,110 @@
<!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>Buildable models &mdash; django-bakery 0.3.2 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.3.2',
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="django-bakery 0.3.2 documentation" href="index.html" />
<link rel="next" title="Settings variables" href="settingsvariables.html" />
<link rel="prev" title="Buildable views" href="buildableviews.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="settingsvariables.html" title="Settings variables"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="buildableviews.html" title="Buildable views"
accesskey="P">previous</a> |</li>
<li><a href="index.html">django-bakery 0.3.2 documentation</a> &raquo;</li>
</ul>
</div>

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

<div class="section" id="buildable-models">
<h1>Buildable models<a class="headerlink" href="#buildable-models" title="Permalink to this headline"></a></h1>
</div>


</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="buildableviews.html"
title="previous chapter">Buildable views</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="settingsvariables.html"
title="next chapter">Settings variables</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/buildablemodels.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" />
<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="settingsvariables.html" title="Settings variables"
>next</a> |</li>
<li class="right" >
<a href="buildableviews.html" title="Buildable views"
>previous</a> |</li>
<li><a href="index.html">django-bakery 0.3.2 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2014, Los Angeles Times Data Desk.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>
24 changes: 12 additions & 12 deletions docs/_build/html/gettingstarted.html
View file
Expand Up @@ -70,22 +70,22 @@ <h1>Getting started<a class="headerlink" href="#getting-started" title="Permalin
</pre></div>
</div>
<p>The cru­cial step is to re­fact­or your views to in­her­it our <a class="reference internal" href="buildableviews.html"><em>buildable class-based views</em></a>. They are similar to Django&#8217;s <a class="reference external" href="https://docs.djangoproject.com/en/dev/topics/class-based-views/">generic class-based views</a>, except extended to know how to auto­mat­ic­ally build them­selves as flat files. Here is a list view and a de­tail view us­ing our sys­tem.</p>
<div class="highlight-python"><div class="highlight"><pre>from yourapp.mod­els im­port Dummy­Mod­el
from bakery.views im­port Build­able­De­tailView, Build­ableL­istView
<div class="highlight-django"><div class="highlight"><pre><span class="x">from yourapp.mod­els im­port Dummy­Mod­el</span>
<span class="x">from bakery.views im­port Build­able­De­tailView, Build­ableL­istView</span>


class DummyL­istView(Build­ableL­istView):
&quot;&quot;&quot;
A list of all tables.
&quot;&quot;&quot;
queryset = Dummy­Mod­el.live.all()
<span class="x">class DummyL­istView(Build­ableL­istView):</span>
<span class="x"> &quot;&quot;&quot;</span>
<span class="x"> A list of all tables.</span>
<span class="x"> &quot;&quot;&quot;</span>
<span class="x"> queryset = Dummy­Mod­el.live.all()</span>


class DummyDe­tailView(Build­able­De­tailView):
&quot;&quot;&quot;
All about one table.
&quot;&quot;&quot;
queryset = Dummy­Mod­el.live.all()
<span class="x">class DummyDe­tailView(Build­able­De­tailView):</span>
<span class="x"> &quot;&quot;&quot;</span>
<span class="x"> All about one table.</span>
<span class="x"> &quot;&quot;&quot;</span>
<span class="x"> queryset = Dummy­Mod­el.live.all()</span>
</pre></div>
</div>
<p>After you’ve con­ver­ted your views, add them to a list in <tt class="docutils literal"><span class="pre">settings.py</span></tt> where all build­able views will be collected.</p>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/index.html
View file
Expand Up @@ -54,6 +54,7 @@ <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to
<ul>
<li class="toctree-l1"><a class="reference internal" href="gettingstarted.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="buildableviews.html">Buildable views</a></li>
<li class="toctree-l1"><a class="reference internal" href="buildablemodels.html">Buildable models</a></li>
<li class="toctree-l1"><a class="reference internal" href="settingsvariables.html">Settings variables</a></li>
<li class="toctree-l1"><a class="reference internal" href="managementcommands.html">Management commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="celeryintegration.html">Celery integration</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions docs/buildablemodels.rst
View file
@@ -0,0 +1,2 @@
Buildable models
================
2 changes: 1 addition & 1 deletion docs/gettingstarted.rst
View file
Expand Up @@ -28,7 +28,7 @@ Also in ``settings.py``, add a build directory where the site will be built as f
The cru­cial step is to re­fact­or your views to in­her­it our :doc:`buildable class-based views </buildableviews>`. They are similar to Django's `generic class-based views <https://docs.djangoproject.com/en/dev/topics/class-based-views/>`_, except extended to know how to auto­mat­ic­ally build them­selves as flat files. Here is a list view and a de­tail view us­ing our sys­tem.

.. code-block:: python
.. code-block:: django
from yourapp.mod­els im­port Dummy­Mod­el
from bakery.views im­port Build­able­De­tailView, Build­ableL­istView
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
View file
Expand Up @@ -11,6 +11,7 @@ Documentation

gettingstarted
buildableviews
buildablemodels
settingsvariables
managementcommands
celeryintegration
Expand Down

0 comments on commit 9d6cc34

Please sign in to comment.