Changeset 48:e1a22d078bbb in stamper for docs

Timestamp:

Aug 14, 2014, 9:36:15 AM (10 years ago)

Author:

Borja Lopez <borja@…>

Branch:

default

Phase:

public

Tags:

0.1

Message:

Do not use argparse sphinx integration in the docs.

Location:

docs

Files:

• _build/doctrees/environment.pickle (modified) ( previous)
• _build/doctrees/index.doctree (modified) ( previous)
• _build/doctrees/using.doctree (modified) ( previous)
• _build/html/_sources/using.txt (modified) (2 diffs)
• _build/html/searchindex.js (modified) (1 diff)
• _build/html/using.html (modified) (2 diffs)
• using.rst (modified) (2 diffs)

docs/_build/html/_sources/using.txt

@@ -161 +161 @@
 -------------------------------
 
-You can get the full list of arguments from the command line too::
+You can get the full list of arguments from the command line::
 
   stamps -h
@@ -169 +169 @@
   stamps --help
 
-.. argparse::
-   :module: stamper.cli
-   :func: build_args_parser
-   :prog: stamper
 
 

docs/_build/html/searchindex.js

@@ -1 @@
-Search.setIndex({envversion:42,terms:{all:3,code:1,identifi:[3,1],forget:1,just:[3,2],show:3,text:[3,1],offici:0,verbos:3,becaus:1,interchang:1,human:1,follow:3,still:1,import_fil:3,languag:1,help:3,onli:3,slow:1,group:3,cli:3,easi:[1,2],how:2,graph:3,welter:1,ideal:1,littl:1,tail:1,program:1,dict:1,queri:1,save:[3,1],custom:[3,1],them:3,independ:1,"return":3,string:3,get:[3,1],python:[0,1,2],familiar:1,pypi:2,dai:1,obtain:1,repo:3,know:2,instead:1,report:1,bar:3,bit:1,month:3,sascha:1,betabug:[3,1],magic:1,like:1,did:[3,1],list:1,html:2,easili:1,exampl:[3,1],statist:1,each:3,januari:3,difficult:1,page:0,mean:1,subset:1,properti:1,timelin:[],some:[3,1,2],idea:1,born:1,cost:1,"export":1,result:3,year:3,extract:1,even:1,index:0,what:[3,1],insensit:3,implement:3,"3rd":1,space:3,miss:3,someth:1,below:3,per:1,your:[3,1,2],current:3,delet:3,written:[0,1],between:3,"import":[3,1],experi:2,ref:3,whatev:1,machin:1,afterward:1,full:[],august:3,situat:3,gener:[3,1],javascript:1,usag:3,here:1,standard:[1,2],base:1,nice:3,org:[1,2],sinc:3,search:0,last:3,wai:3,most:[3,1],keep:3,filter:[],etc:2,amount:1,tutori:2,fals:3,mani:1,chang:3,ecma:1,first:3,origin:1,yyyi:3,rang:3,simpli:3,ago:3,render:3,point:3,appli:3,modul:[0,2],inspir:1,easy_instal:2,yourself:3,instruct:[],alreadi:[3,2],famili:1,instal:[],next:3,open:1,workstamp:3,quit:[1,2],given:3,java:1,convent:1,stamp:1,perl:1,avail:2,start:[3,1],call:3,editor:1,handl:3,txt:1,conveni:1,store:3,includ:[3,1],project:[3,1],head:1,option:3,name:3,juli:3,edit:1,argument:[],pars:1,too:3,line:[3,1],those:[3,1],"case":3,notat:1,retriev:[],look:1,provid:[3,1],intal:2,seealso:3,work:[3,1],onc:1,structur:1,cat:1,bebu:3,matter:3,calcul:1,doc:[1,2],limit:3,can:[3,1],learn:3,posit:3,more:3,similar:3,favourit:[1,2],file:[3,1],creat:3,certain:1,dure:3,ani:3,ugli:1,strongli:1,packag:2,exist:[],have:[3,1,2],lightweight:1,pip:2,dedic:1,check:1,again:[3,1],end:3,want:3,thing:3,perform:1,anoth:3,make:1,format:[3,1],when:[3,1],detail:[],same:3,date_based_filt:3,write:[3,1],also:3,need:1,other:[3,1],take:3,varieti:1,test:3,record:1,you:[3,1,2],document:1,simpl:1,complet:1,week:3,finish:[3,1],http:[3,1,2],imagin:3,track:0,stop:3,symbol:3,after:3,chart:[],befor:3,programm:1,date:[],data:1,aka:1,tradit:1,task:[3,1],don:3,read:1,entri:1,descript:[3,1],svg:3,object:1,inform:1,without:3,command:3,thi:[0,1,3],time:1,far:3,link:3,decemb:1,spent:1,sum:3,latest:3},objtypes:{},objnames:{},filenames:["index","about","install","using"],titles:["Welcome to Stamper’s documentation!","About Stamper","Installation instructions","How to use it"],objects:{},titleterms:{timelin:3,argument:3,indic:0,instruct:2,stamper:[0,1],exist:3,tabl:0,instal:2,total:3,from:[3,1],welcom:0,inform:3,stamp:3,detail:3,per:3,content:[3,1],how:3,json:1,consecut:3,document:0,full:3,tool:1,enter:1,dai:3,chart:3,base:3,date:3,come:1,about:1,retriev:3,list:3,doe:1,filter:3,record:3,time:3,where:1}})
+Search.setIndex({envversion:42,terms:{all:3,code:1,identifi:[3,1],forget:1,just:[3,2],show:3,perl:1,text:[3,1],offici:0,verbos:[],becaus:1,interchang:1,human:1,follow:3,still:1,import_fil:[],languag:1,help:3,onli:3,slow:1,group:3,cli:3,easi:[1,2],also:3,graph:[],welter:1,ideal:1,littl:1,tail:1,program:1,dict:1,queri:1,save:[3,1],bebu:3,them:3,inspir:1,"return":3,string:3,get:[3,1],python:[0,1,2],familiar:1,pypi:2,dai:[],obtain:1,repo:3,know:2,instead:1,report:1,bar:3,bit:1,month:3,sascha:1,betabug:[3,1],magic:1,like:1,did:[3,1],list:[],entri:1,easili:1,statist:1,each:3,pars:1,januari:3,difficult:1,page:0,mean:1,subset:1,work:[3,1],timelin:[],some:[3,1,2],idea:1,born:1,cost:1,"export":1,result:3,year:3,extract:1,even:1,index:0,what:[3,1],insensit:3,"3rd":1,space:3,open:1,someth:1,calcul:1,per:[],workstamp:3,current:3,delet:[],written:[0,1],between:3,"import":1,experi:2,ref:3,can:[3,1],machin:1,afterward:1,full:[],august:3,usag:3,gener:[3,1],javascript:1,situat:3,here:1,standard:[1,2],base:[],nice:3,org:[1,2],sinc:3,search:0,last:3,convent:1,befor:3,keep:3,filter:[],etc:2,amount:1,tutori:2,fals:[],mani:1,chang:3,other:[3,1],ecma:1,first:3,origin:1,yyyi:3,rang:[],simpli:3,render:3,point:3,appli:3,modul:[0,2],independ:1,easy_instal:2,yourself:3,instruct:[],alreadi:[3,2],famili:1,instal:[],next:3,miss:3,your:[3,1,2],quit:[1,2],given:3,java:1,wai:3,stamp:[],custom:[3,1],avail:2,start:[3,1],call:3,editor:1,handl:3,txt:1,conveni:1,store:3,includ:1,tradit:1,head:1,option:[],name:3,juli:3,edit:1,ani:3,link:3,too:[],line:[3,1],those:[3,1],"case":3,notat:1,retriev:[],look:1,aka:1,provid:[3,1],intal:2,seealso:3,properti:1,onc:1,structur:1,cat:1,project:[3,1],matter:3,below:3,limit:3,whatev:1,learn:3,posit:[],more:3,similar:3,favourit:[1,2],have:[3,1,2],creat:3,certain:1,dure:3,argument:[],ugli:1,strongli:1,packag:2,exist:[],file:[3,1],lightweight:1,pip:2,dedic:1,check:1,again:[3,1],end:3,want:3,thing:3,perform:1,anoth:3,make:1,format:[3,1],when:[3,1],detail:[],same:3,date_based_filt:3,write:[3,1],how:[],need:1,html:2,take:3,varieti:1,test:3,record:[],you:[3,1,2],document:[],simpl:1,complet:1,week:3,finish:[3,1],http:[3,1,2],imagin:3,track:0,stop:3,symbol:3,after:3,chart:[],most:[3,1],date:[],data:1,implement:3,ago:3,task:[3,1],don:3,read:1,doc:[1,2],descript:[3,1],svg:3,object:1,without:3,inform:[],exampl:[3,1],command:3,thi:[0,1,3],time:[],far:3,programm:1,decemb:1,spent:1,sum:[],latest:3},objtypes:{},objnames:{},filenames:["index","about","install","using"],titles:["Welcome to Stamper’s documentation!","About Stamper","Installation instructions","How to use it"],objects:{},titleterms:{timelin:3,argument:3,indic:0,instruct:2,stamper:[0,1],exist:3,tabl:0,instal:2,total:3,from:[3,1],welcom:0,record:3,stamp:3,detail:3,per:3,content:[3,1],how:3,json:1,consecut:3,document:0,full:3,tool:1,time:3,dai:3,chart:3,base:3,date:3,come:1,about:1,retriev:3,list:3,doe:1,filter:3,inform:3,enter:1,where:1}})

docs/_build/html/using.html

@@ -234 +234 @@
 <div class="section" id="stamps-full-list-of-arguments">
 <h2><a class="toc-backref" href="#id12">stamps - full List of arguments</a><a class="headerlink" href="#stamps-full-list-of-arguments" title="Permalink to this headline">¶</a></h2>
-<p>You can get the full list of arguments from the command line too:</p>
+<p>You can get the full list of arguments from the command line:</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="n">stamps</span> <span class="o">-</span><span class="n">h</span>
 </pre></div>
@@ -242 +242 @@
 </pre></div>
 </div>
-<p>stamps: show recorded times information</p>
-<pre class="literal-block">
-usage: stamper [-h] [-v] [-s] [-g] [-t] [-d DELETE] [-i IMPORT_FILE]
-               [customer] [filter]
-</pre>
-<dl class="docutils">
-<dt>Positional arguments:</dt>
-<dd><table class="first last docutils option-list" frame="void" rules="none">
-<col class="option" />
-<col class="description" />
-<tbody valign="top">
-<tr><td class="option-group">
-<kbd>customer</kbd></td>
-<td>Show times only for this customer</td></tr>
-<tr><td class="option-group">
-<kbd>filter</kbd></td>
-<td>Filter the times by date range</td></tr>
-</tbody>
-</table>
-</dd>
-<dt>Options:</dt>
-<dd><table class="first last docutils option-list" frame="void" rules="none">
-<col class="option" />
-<col class="description" />
-<tbody valign="top">
-<tr><td class="option-group" colspan="2">
-<kbd><span class="option">-v=False</span>, <span class="option">--verbose=False</span></kbd></td>
-</tr>
-<tr><td>&nbsp;</td><td>Include detailed times information</td></tr>
-<tr><td class="option-group" colspan="2">
-<kbd><span class="option">-s=False</span>, <span class="option">--sum=False</span></kbd></td>
-</tr>
-<tr><td>&nbsp;</td><td>Include sum of times</td></tr>
-<tr><td class="option-group" colspan="2">
-<kbd><span class="option">-g=False</span>, <span class="option">--graph=False</span></kbd></td>
-</tr>
-<tr><td>&nbsp;</td><td>Generate a SVG graph</td></tr>
-<tr><td class="option-group" colspan="2">
-<kbd><span class="option">-t=False</span>, <span class="option">--timeline=False</span></kbd></td>
-</tr>
-<tr><td>&nbsp;</td><td>Show a timeline of recorded times</td></tr>
-<tr><td class="option-group">
-<kbd><span class="option">-d</span>, <span class="option">--delete</span></kbd></td>
-<td>Delete up to n recorded stamps</td></tr>
-<tr><td class="option-group">
-<kbd><span class="option">-i</span>, <span class="option">--import</span></kbd></td>
-<td>Import stamps from the given file</td></tr>
-</tbody>
-</table>
-</dd>
-</dl>
 </div>
 <div class="section" id="date-based-filtering">

docs/using.rst

@@ -161 +161 @@
 -------------------------------
 
-You can get the full list of arguments from the command line too::
+You can get the full list of arguments from the command line::
 
   stamps -h
@@ -169 +169 @@
   stamps --help
 
-.. argparse::
-   :module: stamper.cli
-   :func: build_args_parser
-   :prog: stamper