Changed toctree max depth to 3.

Minor refactor on headers for usage docs
This commit is contained in:
Brandon Taylor committed 2014-08-21 12:32:36 -04:00
1 parent 67b6cc0713
commit cf490e7918
12 files changed
+36 -13

No files matched your search

Binary file not shown.
Binary file not shown.
Binary file not shown.
+1 -1
View File
@@ -39,7 +39,7 @@ Contents:
---------
.. toctree::
:maxdepth: 2
:maxdepth: 3
quickstart
configuration
+2 -2
View File
@@ -38,8 +38,8 @@ Example assuming a model named "Category"::
See `this link <http://south.readthedocs.org/en/latest/tutorial/part3.html>`_ for more information on Data Migrations.
Django Admin Integration
^^^^^^^^^^^^^^^^^^^^^^^^
Django Admin
------------
To enable sorting in the admin, you need to inherit from ``SortableAdmin``::
+1
View File
@@ -66,6 +66,7 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Using Django Admin Sortable</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#models">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#django-admin">Django Admin</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="django-cms.html">Django-CMS Integration</a></li>
+12 -1
View File
@@ -66,6 +66,7 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Using Django Admin Sortable</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#models">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#django-admin">Django Admin</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="django-cms.html">Django-CMS Integration</a></li>
@@ -150,7 +151,17 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Using Django Admin Sortable</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#models">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#models">Models</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage.html#adding-sortable-to-an-existing-model">Adding Sortable to an existing model</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#django-admin">Django Admin</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage.html#overriding-queryset">Overriding <code class="docutils literal"><span class="pre">queryset()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="usage.html#overriding-queryset-for-an-inline-model">Overriding <code class="docutils literal"><span class="pre">queryset()</span></code> for an inline model</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage.html#sorting-subsets-of-objects">Sorting subsets of objects</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage.html#extending-custom-templates">Extending custom templates</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="django-cms.html">Django-CMS Integration</a></li>
+1
View File
@@ -65,6 +65,7 @@
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Using Django Admin Sortable</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#models">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#django-admin">Django Admin</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="django-cms.html">Django-CMS Integration</a></li>
+1 -1
View File
@@ -1 +1 @@
Search.setIndex({envversion:42,terms:{all:8,code:8,plugin_bas:10,follow:8,row:7,whose:4,depend:8,cmspluginbas:10,positivesmallinteg:8,under:3,introduc:[8,1,7],rel:[8,10],fals:[8,10],util:8,context_processor:[9,2],veri:8,change_form_templ:10,list:8,last_nam:8,item:1,small:8,sortablestackedinlin:8,pleas:1,fortun:10,pass:[8,2],click:5,compat:1,index:[8,1],appear:8,mysortabletabularinlin:8,abl:8,change_list:8,"new":[],"public":3,gener:8,here:[8,2],valu:8,search:1,extrahead:10,stackedinlin:8,opinion:7,chang:[8,1,4,5,10],honor:8,via:5,extra:[8,2],appli:8,modul:1,prefer:9,href:10,instal:2,unit:[6,5],register_plugin:10,from:[2,4,5,10,8,9],would:8,regist:[8,2],two:8,few:[8,9],stylesheet:10,recommend:8,taken:5,type:10,more:[8,2],sort:[],desir:2,peopl:8,get_queryset:8,site:[8,2],known:[],must:8,placehold:10,work:[8,5,10],can:[8,5,2,9],caveat:8,def:[8,10,2],quickstart:[],sortablegenericstackedinlin:8,tabular:[8,10],minimum:10,mysortablestackedinlin:8,edit_inlin:8,first_nam:8,anoth:8,cmscarouselplugin:10,instead:8,simpl:9,css:[8,9,10],updat:[1,10],product:0,after:8,befor:8,mai:[8,1,5],associ:7,feasibl:10,credenti:5,imposs:7,issu:[],inform:8,allow:[8,10],tall:8,order:[8,5,2],help:6,anticip:8,over:8,move:6,becaus:4,through:1,dynam:8,group:[8,1,7],thank:1,them:8,"return":[8,10,2],python:[1,5],now:2,nor:7,name:[8,10],anyth:8,edit:7,drop:[5,2],each:8,found:5,inhert:4,individu:1,realli:[6,10],contrib:8,meta:[8,2],"static":2,special:8,out:6,categori:8,rational:[],plugin_change_form:10,insid:9,migrat:8,sortabletabularinlin:8,standard:8,base:[8,1,7],dictionari:8,releas:3,render_templ:10,could:6,filter:8,pagin:7,charfield:[8,2],top:7,south:8,render:10,onc:8,independ:8,number:8,cmsplugin:10,change_form:8,alreadi:10,stabl:0,installed_app:[9,2],script:10,data:8,licens:1,sometim:8,max_length:[8,2],carousel:10,schema:8,option:[8,2],travi:6,tool:[5,2],copi:9,specifi:[8,10],entequak:1,exactli:8,serv:9,provid:8,get_is_sort:8,jqueri:10,sai:5,changelist:[2,7],ani:[8,1,5,2],have:[8,4,5,2,7],need:[8,10,2],seem:7,incompat:[8,1],equival:8,min:10,self:[8,6,2,10],note:8,also:[8,1],take:2,which:[8,7],normal:8,sorting_filt:[8,1],object:2,change_list_template_extend:8,why:8,don:8,request:8,doe:[4,7],sample_project:5,determin:8,left:8,text:[8,10],directli:5,current:[0,4],onli:10,componentinlin:8,locat:9,apach:3,should:2,title__icontain:8,folder:9,adminsort:[8,9,2,10],hit:8,get:[9,2],csrf:10,increas:8,is_sort:8,tbd:[],requir:8,enabl:[8,1],method:[8,9],where:[5,2],view:[8,5,2,7],set:[8,2],see:[8,5],project:[2,5,6,7,8,9],statu:[],wire:2,parent:[8,4],enumer:8,won:[8,10],between:7,"import":[8,10,2],across:7,attribut:[8,1],altern:9,kei:[6,7],javascript:[8,9,10],distinguish:7,"__unicode__":[8,2],addit:8,change_form_template_extend:8,plugin:10,howev:7,foreign:[6,7],instanc:10,context:10,login:5,load:10,simpli:2,instanti:8,height:8,assum:8,quit:9,coupl:7,due:8,compon:8,much:7,present:[8,2],"case":8,look:[8,5],properti:8,defin:[8,2],endblock:10,almost:1,non:8,myapp:8,mysortableadminclass:[8,2],suggest:8,make:[8,7],referenti:6,same:8,member:8,html:[8,10],ascend:8,difficult:8,director:8,stack:[8,10],appropri:8,thu:10,inherit:[8,2],person:8,exampl:[8,10],thi:[8,6,5,7,10],admin_preview:10,model:[5,2],latest:1,just:[10,7],previous:8,foo:8,easi:[1,10],littl:7,add:[8,1,9,2],board:8,els:8,save:8,app:[5,9],plugin_pool:10,format:[8,1],is_board_memb:8,template_context_processor:[9,2],resolv:10,staticfil:[9,10],necessari:10,either:8,page:[1,10,7],right:8,sortableadmin:[8,2],some:[8,6],sampl:[8,6],slideinlin:10,substitut:10,select:8,content:[],core:[9,2],run:5,widgetadmin:8,symlink:9,"super":[8,1,10],src:10,about:8,column:8,verbose_name_plur:8,includ:[8,10,5,9],block:10,own:10,inlin:5,within:10,automat:[8,10],orm:8,ensur:[9,2],your:[8,1,9,2],manag:[1,5],wai:[8,1,4],area:5,custom:5,start:2,inner:8,forward:8,tabularinlin:8,"function":5,properli:8,form:[8,4,5,10],tupl:[8,1],link:[8,5,2,10],tabularstackedinlin:8,line:[8,7],sortablegenerictabularinlin:8,"true":8,made:1,possibl:[8,4],"default":[8,7],displai:8,record:[5,7],below:[8,1],foreignkei:8,problem:7,booleanfield:8,creat:8,file:[5,9],pip:2,mysortableclass:[8,2],titl:[8,2],when:[5,2],field:8,other:7,test:[],you:[8,1,5,2,9],"class":[8,10,2],drag:[5,2],directori:[5,9],backward:[8,1]},objtypes:{},objnames:{},filenames:["status","index","quickstart","license","known-issues","testing","future","rationale","usage","configuration","django-cms"],titles:["Status","Welcome to Django Admin Sortable&#8217;s documentation!","Quickstart","License","Known Issue(s)","Testing","Future Plans","Rationale","Using Django Admin Sortable","Configuring Django Admin Sortable","Django-CMS Integration"],objects:{},titleterms:{overrid:8,subset:8,quickstart:2,queryset:8,indic:1,order:7,exist:8,tabl:1,what:1,welcom:1,media:9,support:1,configur:9,custom:8,content:1,version:1,futur:6,rational:7,test:5,"new":1,document:1,higher:[],sort:8,sortabl:[8,1,9],extend:8,object:8,statu:0,drag:7,templat:8,known:4,inlin:8,why:7,plugin:7,admin:[8,1,9],drop:7,django:Line truncated
Search.setIndex({envversion:42,terms:{all:8,code:8,plugin_bas:10,follow:8,row:7,whose:4,depend:8,cmspluginbas:10,positivesmallinteg:8,under:3,introduc:[8,1,7],rel:[8,10],fals:[8,10],util:8,context_processor:[9,2],veri:8,change_form_templ:10,list:8,last_nam:8,item:1,small:8,sortablestackedinlin:8,pleas:1,fortun:10,pass:[8,2],click:5,compat:1,index:[8,1],appear:8,mysortabletabularinlin:8,abl:8,change_list:8,"new":[],"public":3,gener:8,here:[8,2],valu:8,search:1,extrahead:10,stackedinlin:8,opinion:7,chang:[8,1,4,5,10],honor:8,via:5,extra:[8,2],appli:8,modul:1,prefer:9,href:10,instal:2,unit:[6,5],register_plugin:10,from:[2,4,5,10,8,9],would:8,regist:[8,2],two:8,few:[8,9],stylesheet:10,recommend:8,taken:5,type:10,more:[8,2],sort:[],desir:2,peopl:8,get_queryset:8,site:[8,2],known:[],must:8,placehold:10,work:[8,5,10],can:[8,5,2,9],caveat:8,def:[8,10,2],quickstart:[],sortablegenericstackedinlin:8,tabular:[8,10],minimum:10,mysortablestackedinlin:8,edit_inlin:8,first_nam:8,anoth:[],cmscarouselplugin:10,instead:8,simpl:9,css:[8,9,10],updat:[1,10],product:0,after:8,befor:8,mai:[8,1,5],associ:7,feasibl:10,credenti:5,imposs:7,issu:[],inform:8,allow:[8,10],tall:8,order:[5,2],help:6,anticip:8,over:8,move:6,becaus:4,through:1,dynam:8,group:[8,1,7],thank:1,them:8,"return":[8,10,2],python:[1,5],now:2,nor:7,name:[8,10],anyth:8,edit:7,drop:[5,2],each:8,found:5,inhert:4,individu:1,realli:[6,10],contrib:8,meta:[8,2],"static":2,special:8,out:6,categori:8,rational:[],plugin_change_form:10,insid:9,migrat:8,sortabletabularinlin:8,standard:8,base:[8,1,7],dictionari:8,releas:3,render_templ:10,could:6,filter:8,pagin:7,charfield:[8,2],top:7,south:8,render:10,onc:8,independ:8,number:8,cmsplugin:10,change_form:8,alreadi:10,stabl:0,installed_app:[9,2],script:10,data:8,licens:[],sometim:8,max_length:[8,2],carousel:10,schema:8,option:[8,2],travi:6,tool:[5,2],copi:9,specifi:[8,10],entequak:1,exactli:8,serv:9,provid:8,get_is_sort:8,jqueri:10,sai:5,changelist:[2,7],ani:[8,1,5,2],have:[8,4,5,2,7],need:[8,10,2],seem:7,incompat:[8,1],equival:8,min:10,self:[8,6,2,10],note:8,also:[8,1],take:2,which:[8,7],normal:8,sorting_filt:[8,1],object:2,change_list_template_extend:8,why:[],don:8,request:8,doe:[4,7],sample_project:5,determin:8,left:8,text:[8,10],directli:5,current:[0,4],onli:10,componentinlin:8,locat:9,apach:3,should:2,title__icontain:8,folder:9,adminsort:[8,9,2,10],hit:8,get:[9,2],csrf:10,increas:8,is_sort:8,tbd:[],requir:8,enabl:[8,1],method:[8,9],where:[5,2],view:[8,5,2,7],set:[8,2],see:[8,5],project:[2,5,6,7,8,9],statu:[],wire:2,parent:[8,4],enumer:8,won:[8,10],between:7,"import":[8,10,2],across:7,attribut:[8,1],altern:9,kei:[6,7],javascript:[8,9,10],distinguish:7,"__unicode__":[8,2],addit:8,change_form_template_extend:8,plugin:10,howev:7,foreign:[6,7],instanc:10,context:10,login:5,load:10,simpli:2,instanti:8,height:8,assum:8,quit:9,coupl:7,due:8,compon:8,much:7,present:[8,2],"case":8,look:[8,5],properti:8,defin:[8,2],endblock:10,almost:1,non:8,myapp:8,mysortableadminclass:[8,2],suggest:8,make:[8,7],referenti:6,same:8,member:8,html:[8,10],ascend:8,difficult:8,director:8,stack:[8,10],appropri:8,thu:10,inherit:[8,2],person:8,exampl:[8,10],thi:[8,6,5,7,10],admin_preview:10,model:[5,2],latest:1,just:[10,7],previous:8,foo:8,easi:[1,10],littl:7,add:[8,1,9,2],board:8,els:8,save:8,app:[5,9],plugin_pool:10,format:[8,1],is_board_memb:8,template_context_processor:[9,2],resolv:10,staticfil:[9,10],necessari:10,either:8,page:[1,10,7],right:8,sortableadmin:[8,2],some:[8,6],sampl:[8,6],slideinlin:10,substitut:10,select:8,content:[],core:[9,2],run:5,widgetadmin:8,symlink:9,"super":[8,1,10],src:10,about:8,column:8,verbose_name_plur:8,includ:[8,10,5,9],block:10,own:10,inlin:5,within:10,automat:[8,10],orm:8,ensur:[9,2],your:[8,1,9,2],manag:[1,5],wai:[8,1,4],area:5,custom:5,start:2,inner:8,forward:8,tabularinlin:8,"function":5,properli:8,form:[8,4,5,10],tupl:[8,1],link:[8,5,2,10],tabularstackedinlin:8,line:[8,7],sortablegenerictabularinlin:8,"true":8,made:1,possibl:[8,4],"default":[8,7],displai:8,record:[5,7],below:[8,1],foreignkei:8,problem:7,booleanfield:8,creat:8,file:[5,9],pip:2,mysortableclass:[8,2],titl:[8,2],when:[5,2],field:8,other:7,test:[],you:[8,1,5,2,9],"class":[8,10,2],drag:[5,2],directori:[5,9],backward:[8,1]},objtypes:{},objnames:{},filenames:["status","index","quickstart","license","known-issues","testing","future","rationale","usage","configuration","django-cms"],titles:["Status","Welcome to Django Admin Sortable&#8217;s documentation!","Quickstart","License","Known Issue(s)","Testing","Future Plans","Rationale","Using Django Admin Sortable","Configuring Django Admin Sortable","Django-CMS Integration"],objects:{},titleterms:{overrid:8,subset:8,quickstart:2,queryset:8,indic:1,order:7,exist:8,tabl:1,what:1,welcom:1,media:9,support:1,configur:9,custom:8,content:1,version:1,futur:6,rational:7,test:5,"new":1,document:1,higher:[],sort:8,sortabl:[8,1,9],extend:8,object:8,statu:0,drag:7,templat:8,known:4,inlin:8,why:7,plugin:7,admin:[8,1,9],drop:7,djangoLine truncated
+15 -5
View File
@@ -29,7 +29,7 @@
<link rel="top" title="Django Admin Sortable 1.7.0 documentation" href="index.html"/>
<link rel="next" title="Testing" href="testing.html"/>
<link rel="next" title="Django-CMS Integration" href="django-cms.html"/>
<link rel="prev" title="Configuring Django Admin Sortable" href="configuration.html"/>
@@ -67,9 +67,19 @@
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Using Django Admin Sortable</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#models">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="#django-admin">Django Admin</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="django-cms.html">Django-CMS Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="known-issues.html">Known Issue(s)</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="rationale.html">Rationale</a><ul>
<li class="toctree-l2"><a class="reference internal" href="rationale.html#why-another-drag-and-drop-ordering-plugin">Why another drag-and-drop ordering plugin?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="status.html">Status</a></li>
<li class="toctree-l1"><a class="reference internal" href="future.html">Future Plans</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
@@ -140,8 +150,9 @@
</div>
<p>See <a class="reference external" href="http://south.readthedocs.org/en/latest/tutorial/part3.html">this link</a> for more information on Data Migrations.</p>
</div>
<div class="section" id="django-admin-integration">
<h3>Django Admin Integration<a class="headerlink" href="#django-admin-integration" title="Permalink to this headline"></a></h3>
</div>
<div class="section" id="django-admin">
<h2>Django Admin<a class="headerlink" href="#django-admin" title="Permalink to this headline"></a></h2>
<p>To enable sorting in the admin, you need to inherit from <code class="docutils literal"><span class="pre">SortableAdmin</span></code>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">django.contrib</span> <span class="kn">import</span> <span class="n">admin</span>
<span class="kn">from</span> <span class="nn">myapp.models</span> <span class="kn">import</span> <span class="n">MySortableClass</span>
@@ -173,7 +184,6 @@
&quot;&quot;&quot;Your generic inline options go here&quot;&quot;&quot;
</pre></div>
</div>
</div>
<div class="section" id="overriding-queryset">
<h3>Overriding <code class="docutils literal"><span class="pre">queryset()</span></code><a class="headerlink" href="#overriding-queryset" title="Permalink to this headline"></a></h3>
<p>django-admin-sortable supports custom queryset overrides on admin models and inline models in Django admin!</p>
@@ -270,7 +280,7 @@ The height of a stacked inline model can dynamically increase, which can make th
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="testing.html" class="btn btn-neutral float-right" title="Testing">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="django-cms.html" class="btn btn-neutral float-right" title="Django-CMS Integration">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="configuration.html" class="btn btn-neutral" title="Configuring Django Admin Sortable"><span class="fa fa-arrow-circle-left"></span> Previous</a>