searchindex.js

Search.setIndex({docnames:["api","changelog","commandline","index","recipes","releasing","tests"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["api.rst","changelog.rst","commandline.rst","index.rst","recipes.rst","releasing.rst","tests.rst"],objects:{"doctr-configure":{"--force":[2,3,1,"cmdoption-doctr-configure-force"],"--help":[2,3,1,"cmdoption-doctr-configure-h"],"--key-path":[2,3,1,"cmdoption-doctr-configure-key-path"],"--no-authenticate":[2,3,1,"cmdoption-doctr-configure-no-authenticate"],"--no-upload-key":[2,3,1,"cmdoption-doctr-configure-no-upload-key"],"--token":[2,3,1,"cmdoption-doctr-configure-token"],"--travis-tld":[2,3,1,"cmdoption-doctr-configure-travis-tld"],"-h":[2,3,1,"cmdoption-doctr-configure-h"]},"doctr-deploy":{"--branch-whitelist":[2,3,1,"cmdoption-doctr-deploy-branch-whitelist"],"--build-tags":[2,3,1,"cmdoption-doctr-deploy-build-tags"],"--built-docs":[2,3,1,"cmdoption-doctr-deploy-built-docs"],"--command":[2,3,1,"cmdoption-doctr-deploy-command"],"--deploy-branch-name":[2,3,1,"cmdoption-doctr-deploy-deploy-branch-name"],"--deploy-repo":[2,3,1,"cmdoption-doctr-deploy-deploy-repo"],"--exclude":[2,3,1,"cmdoption-doctr-deploy-exclude"],"--force":[2,3,1,"cmdoption-doctr-deploy-force"],"--gh-pages-docs":[2,3,1,"cmdoption-doctr-deploy-gh-pages-docs"],"--help":[2,3,1,"cmdoption-doctr-deploy-h"],"--key-path":[2,3,1,"cmdoption-doctr-deploy-key-path"],"--no-build-tags":[2,3,1,"cmdoption-doctr-deploy-no-build-tags"],"--no-force":[2,3,1,"cmdoption-doctr-deploy-no-force"],"--no-push":[2,3,1,"cmdoption-doctr-deploy-no-push"],"--no-require-master":[2,3,1,"cmdoption-doctr-deploy-no-require-master"],"--no-sync":[2,3,1,"cmdoption-doctr-deploy-no-sync"],"--no-temp-dir":[2,3,1,"cmdoption-doctr-deploy-no-temp-dir"],"--no-token":[2,3,1,"cmdoption-doctr-deploy-no-token"],"--push":[2,3,1,"cmdoption-doctr-deploy-push"],"--require-master":[2,3,1,"cmdoption-doctr-deploy-require-master"],"--sync":[2,3,1,"cmdoption-doctr-deploy-sync"],"--token":[2,3,1,"cmdoption-doctr-deploy-token"],"-h":[2,3,1,"cmdoption-doctr-deploy-h"],deploy_directory:[2,3,1,"cmdoption-doctr-deploy-arg-deploy_directory"]},"doctr.local":{AuthenticationFailed:[0,1,1,""],GitHubError:[0,1,1,""],GitHub_login:[0,2,1,""],GitHub_post:[0,2,1,""],GitHub_raise_for_status:[0,2,1,""],check_repo_exists:[0,2,1,""],delete_GitHub_token:[0,2,1,""],encrypt_to_file:[0,2,1,""],encrypt_variable:[0,2,1,""],generate_GitHub_token:[0,2,1,""],generate_ssh_key:[0,2,1,""],get_travis_token:[0,2,1,""],guess_github_repo:[0,2,1,""],upload_GitHub_deploy_key:[0,2,1,""]},"doctr.travis":{checkout_deploy_branch:[0,2,1,""],commit_docs:[0,2,1,""],copy_to_tmp:[0,2,1,""],create_deploy_branch:[0,2,1,""],decrypt_file:[0,2,1,""],deploy_branch_exists:[0,2,1,""],determine_push_rights:[0,2,1,""],find_sphinx_build_dir:[0,2,1,""],get_current_repo:[0,2,1,""],get_token:[0,2,1,""],get_travis_branch:[0,2,1,""],is_subdir:[0,2,1,""],last_commit_by_doctr:[0,2,1,""],push_docs:[0,2,1,""],run:[0,2,1,""],set_git_user_email:[0,2,1,""],setup_GitHub_push:[0,2,1,""],setup_deploy_key:[0,2,1,""],sync_from_log:[0,2,1,""]},doctr:{"--help":[2,3,1,"cmdoption-doctr-h"],"--version":[2,3,1,"cmdoption-doctr-V"],"-V":[2,3,1,"cmdoption-doctr-V"],"-h":[2,3,1,"cmdoption-doctr-h"],local:[0,0,0,"-"],travis:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","exception","Python exception"],"2":["py","function","Python function"],"3":["std","cmdoption","program option"]},objtypes:{"0":"py:module","1":"py:exception","2":"py:function","3":"std:cmdoption"},terms:{"0o600":0,"100":[1,6],"101":1,"103":1,"111":1,"114":1,"116":1,"120":1,"121":1,"123":1,"125":1,"126":1,"127":1,"128":1,"129":1,"130":1,"132":1,"133":1,"134":1,"137":1,"138":1,"139":1,"143":1,"146":1,"147":1,"150":1,"151":1,"160":1,"179":1,"181":1,"186":1,"187":1,"188":1,"190":1,"192":1,"193":1,"196":1,"2016":3,"2017":3,"2018":3,"2019":3,"203":1,"215":1,"216":1,"217":1,"219":1,"222":1,"225":1,"232":1,"235":1,"239":1,"249":1,"250":1,"252":1,"259":1,"260":1,"261":1,"262":1,"263":1,"265":1,"266":1,"267":1,"270":1,"276":1,"279":1,"280":1,"284":1,"289":1,"291":1,"294":1,"296":1,"298":1,"2fa":1,"303":1,"306":1,"310":1,"318":1,"320":1,"325":1,"330":1,"332":1,"333":1,"334":1,"337":1,"338":1,"boolean":1,"byte":0,"case":3,"default":[0,1,2,3,4],"function":[0,6],"new":[1,4,6],"public":[0,1,2,3,4,6],"return":[0,1],"static":[3,4],"true":[0,1],"try":2,"while":6,Added:1,And:3,Are:[3,6],For:[0,2,3,4],IDE:3,One:4,SMS:1,Such:0,That:3,The:[0,1,2,3,4,5,6],Then:[2,4],There:[1,3,6],These:3,Use:[1,2,4],Useful:2,Using:[1,3],With:4,__main__:1,_target_:0,abil:3,abl:0,about:1,access:[0,1,2,3,6],accident:1,accord:1,account:[1,3,6],across:1,action:1,activ:[0,2],actual:1,add:[1,2,3,4,5,6],added:[0,1,2],addit:[1,2],admin:3,after:[1,4,5],after_success:3,again:1,against:6,all:[0,1,2,3,4,5,6],allow:[1,2,3,4,6],alongsid:3,alreadi:[0,1,3,4],also:[0,1,2,3,4,6],although:3,alwai:[0,1],amazingli:3,ani:[1,2,3],anoth:4,anyth:[0,3],anywai:[1,3],api:[1,3,6],app:[0,6],appear:2,applic:[0,1],arbitrari:3,aren:1,arg:0,argpars:1,argument:[0,1,2,3,4],ask:[0,1,2,4,5],assum:[0,1],attempt:[0,1],attribut:1,auth_typ:0,authent:[0,1,2,3],authenticationfail:0,author:0,autom:[1,6],automat:[0,1,2,3,6],autoprogram:1,autotick:3,avail:[0,2,3,6],avi:3,avoid:[0,1,6],back:0,backward:[0,1,2],banner:1,basic:1,bdist_wheel:5,becaus:[0,1,3],been:[0,1],befor:[0,1,2,4],begin:1,being:[0,1],below:[4,5],better:1,blanchard:1,blog:3,blue:1,bnaul:1,bold:1,bot:3,both:[0,1,2,3,4,6],branch:[0,1,2,3,5,6],branch_whitelist:[0,1],bug:1,build:[0,1,2,4,6],build_repo:0,build_tag:0,builder:1,built:[1,2,3,4],built_doc:[0,2],bunch:3,button:1,call:[0,1,3,4],can:[0,1,2,3,4,5,6],cannot:[3,4],canpush:0,capit:1,cargo:3,carreau:1,caus:[1,3,4],chang:[0,3,6],changelog:[3,5],charact:1,check:[0,1,2,5,6],check_repo_exist:0,checkbox:6,checkout:0,checkout_deploy_branch:0,choldgraf:1,choos:4,chose:1,chosen:4,clarifi:1,cleaner:3,cleanup:1,clearer:1,click:1,client:0,client_id:0,code:[0,1,3,6],color:1,com:[0,1,2,3,4],command:[0,1,3,5],commit:[0,1,2,4,5],commit_doc:[0,1],common:[0,3],commun:3,compat:[0,1,2],complet:[0,3],complic:3,concurr:1,conda:[3,5],condit:1,config:[1,3],configur:[0,1,4,6],conflict:1,conjunct:2,contact:6,contain:3,content:[0,1,3],continu:[3,6],contribut:3,conveni:3,coolteam:4,copi:[0,1,2],copy_to_tmp:0,correct:[0,4],correctli:1,counterpart:1,crash:1,creat:[0,1,2,3,4,5,6],create_deploy_branch:0,credenti:[2,4],critic:1,cryptographi:[1,3],cult:3,current:[0,1],custom:[1,4],dan:1,danielballan:1,data:[0,3],date:5,debug:2,decrypt:[0,3],decrypt_fil:0,delet:[0,1,5],delete_github_token:0,depend:[0,3],deploi:[0,1,3],deploy_branch:0,deploy_branch_exist:0,deploy_branch_nam:2,deploy_dir:4,deploy_directori:2,deploy_kei:0,deploy_repo:[0,2],deprec:[1,2],descript:1,design:3,detect:[1,2],determin:[0,6],determine_push_right:0,dev:4,develop:[0,3,4],devic:0,dictionari:0,did:[1,3],differ:[1,3,4,6],difficult:3,dir:[1,2],directli:5,directori:[0,1,2,4],disabl:1,disallow:1,doc:[0,1,2,3,5],doctr:[0,5],doctr_deploy_encryption_kei:0,doctr_deploy_encryption_key_:1,doctr_deploy_key_:1,doctr_remot:[0,1],document:[1,2,3],doe:[0,1,3,4,6],doesn:[0,1],doing:3,don:[1,2,3],done:[0,1,3,6],doubledash:2,drastic:1,drdoctr:[0,1,2,6],drop:2,dst:[0,1],dure:4,each:[1,4,6],earlier:3,easi:6,easili:3,edit:4,either:[0,2],els:[1,4],email:[0,1],empti:4,enabl:[1,3,4,6],enc:[0,1,2,4],encrypt:[0,1,2,3,4],encrypt_fil:0,encrypt_to_fil:0,encrypt_vari:0,end:[0,2],endpoint:1,enough:3,enter:3,entir:3,env:[0,3],env_nam:0,environ:[0,1,3,4,6],equal:0,error:[0,1,6],especi:[1,3],etc:6,even:[0,2],everi:[0,1,2],everyth:3,exampl:[2,3,4],except:[0,1,2],exclud:[0,1,2],exist:[0,1,3,4],exit:[0,2],expir:1,explicitli:1,express:2,extens:[0,1,2],extra:1,factor:1,fail:[1,3],failur:1,fall:0,fals:[0,3],featur:3,feedstock:5,feel:3,fernet:3,field:6,file:[0,1,2,4],filenam:0,find:[0,3],find_sphinx_build_dir:0,first:[0,1,2,3,6],fix:1,flag:[1,2,3,4,5],flow:0,folder:3,follow:[0,2,4],forc:2,forg:[3,5],fork:[0,1,4,5],form:[0,4],format:0,found:[1,3],free:[0,6],from:[0,1,2,3,5,6],full_key_path:0,furthermor:3,futur:1,gem:3,gener:[0,1,2,3,4],generate_github_token:0,generate_ssh_kei:0,get:[0,1,5,6],get_current_repo:0,get_temporary_token:0,get_token:0,get_travis_branch:0,get_travis_token:0,gh_page:3,gh_pages_doc:2,gh_token:0,git:[0,1,3,5],github:[0,1,2,3],github_deploy_kei:[0,1],github_deploy_key_:2,github_deploy_key_org_repo:4,github_login:0,github_post:0,github_raise_for_statu:0,github_token:0,githuberror:0,give:[3,4],given:[1,3],glob:3,global:[0,1,3],going:3,good:3,grai:1,grant:[2,3],great:3,green:1,guess:[0,1],guess_github_repo:0,guid:3,handl:3,happen:1,hard:[1,6],has:[0,1,3,4,6],have:[0,1,3,5,6],head:0,header:0,help:[1,3,4],here:[0,3,4,5],hide:[0,3],hit:1,host:1,hour:[1,6],how:5,howev:[3,4,6],html:[2,3,4],http:[0,2,3,4,6],ignor:[0,1],immedi:[0,1],impli:[0,1,2],imposs:5,improv:1,includ:[0,1,4,5],index:[1,2,3,4],indic:[0,1],infinit:[0,1,4],inform:[1,2],input:[1,4],insert:2,instal:1,instanc:[2,4],instead:[0,1],instruct:[1,3,4],interfac:1,invalid:[1,6],invers:2,involv:3,is_subdir:0,isn:[0,1],issu:[0,1],item:1,its:1,itself:[1,3,4,6],json:0,just:[0,1,4,5,6],keep:3,kei:[0,1,2,3,4,6],kept:2,key_ext:0,key_path:2,keygen:1,keypath:0,keyword:[0,3],kill:1,kind:3,know:[1,3],languag:[2,3],larg:1,last:[2,4],last_commit_by_doctr:0,lastli:4,latest:[0,1,4],leak:[0,3],let:3,like:[0,1,2,3,4,5],limit:[1,3,6],line:[0,1,3],linger:1,link:[1,4],list:[0,1,2,3,4],littl:6,local:[2,3],locat:[0,1,2],log:[0,1,3],log_fil:0,logfil:0,logic:1,login:[0,1,2],login_kwarg:0,long_descript:1,longer:1,look:3,loop:[0,1,4],lot:6,machin:2,made:[0,6],magenta:1,mai:[0,3,4],main:[1,4],maintain:3,make:[0,1,2,3,4,5,6],manag:[3,4],mani:[1,3,6],manual:[1,4,6],master:[0,1,2,3,5],match:2,materi:3,matrix:3,mean:1,measur:3,merg:[1,4,5],messag:[0,1,2,5],might:6,migrat:6,mirror:2,miss:3,modul:[1,3],more:[1,2,3,4],most:[0,1,3],move:1,multipl:[0,1],must:[1,4,6],myorg:2,myrepo:2,name:[0,1,2,3,4,5,6],natur:3,necessari:[1,3,4,6],need:[0,1,3,4,5],neither:[0,6],newer:3,next:3,non:[0,1,3],none:[0,2],nonzero:0,nor:0,normal:4,note:[0,1,2,4],noth:0,now:[1,2,3],number:[1,2,4,5],oauth:[0,1],object:0,obtain:0,occur:1,ocefpaf:1,often:[1,3],old:1,onc:[1,3,5],one:[0,1,2,3,4,6],ones:1,onli:[0,1,2,3,4,6],option:[1,2,3,4],order:[1,3,6],org:[0,1,2,3,4],organ:[1,3,4,6],origin:[0,1,3,5],other:[1,2,3,4,5],otherwis:[0,2,3,4],otp:0,our:1,out:[0,1,4],output:[0,1,3,4],over:[2,6],overwrit:1,owner:4,page:[0,1,2,3,6],paid:6,paramet:[1,2],pass:[0,2,5],password:[0,1,3],past:[1,4,6],path:[0,1,2,3],pem:0,per:4,perform:1,permiss:[0,1],person:[1,2,3,6],ping:1,pip:3,place:6,plan:[5,6],pleas:3,possibl:[1,4,6],post:[0,3],preced:2,prefix:2,present:[0,1,2,6],prevent:[1,2,3],previou:1,previous:1,print:[0,1,4],privat:[0,1,2,3],privileg:6,pro:0,process:3,program:2,project:1,prompt:[1,2,4],properli:1,protect:[1,3,5],provid:0,public_kei:0,public_repo:0,publicli:4,pull:[1,2,3,4,5],purpos:4,push:[0,1,2,3,4,5,6],push_doc:[0,1],put:[3,5],pygb:3,python:[0,1,2,3,5],race:1,rais:[0,6],raise_for_statu:0,rate:1,read:[2,3],read_onli:0,readm:1,readthedoc:3,real:1,reason:1,receiv:1,recent:1,recip:[1,3],recommend:[0,1,2,3,5],reconfigur:1,recurs:3,red:1,regener:6,regro:3,regular:[0,2],releas:[1,3,4],remot:[0,1],remov:[0,1,4],renam:1,render:1,replac:1,repo:[0,1,2,3,6],reponam:1,repositori:[0,1,2,3,4],reproduc:3,request:[0,1,2,3,4,5,6],requir:[0,1,2,3,4],require_mast:[0,1],rerun:3,reset:1,respons:0,respositori:2,result:1,retri:[0,1],returncod:0,reus:3,revert:1,revok:[0,3],rigamarol:1,right:2,robust:0,root:[1,2,4],rst:5,rubi:3,run:[0,1,2,4,6],runtimeerror:0,same:[0,1,3,4,6],save:[0,2],scope:0,screen:4,script:[2,3,4],sdist:5,search:3,secret:0,section:[2,3],secur:[1,2,3,4],see:[0,1,2,3],seem:3,select:6,self:3,separ:[1,2,3],serv:4,server:0,servic:0,set:[0,1,2,3,6],set_git_user_email:0,setup:[0,1,4,5],setup_deploy_kei:0,setup_github_push:[0,1],sever:3,share:1,shell:[0,1],should:[0,1,2,3,4,5,6],show:2,sibl:2,sidebar:1,simpli:0,singl:[1,3],sit:3,site:4,skip:1,some:[1,3,4,5],someon:4,someth:[1,3,4,5],sometim:4,sourc:[0,4],space:1,sparingli:1,special:[1,4],specif:4,specifi:[0,1,2,4],sphinx:[0,1,2,3],sphinxcontrib:1,split:1,spyder:3,src:0,ssh:[0,1,3,4],ssh_kei:0,stack:3,start:0,stash:1,statu:0,step:[1,2,3],still:[1,2,3,4],store:[1,2,4,6],strategi:1,string:[0,6],subcommand:2,subdirectori:0,subfold:0,subprocess:3,sudo:3,suggest:4,suit:6,support:[1,3,4,6],sure:[0,3,4,5,6],swap:1,sympi:3,sync:[0,1,2,3,4],sync_from_log:[0,1],system:0,tabl:1,tag:[1,2,3,5],take:[1,2,3,4],task:3,team:0,techgaun:1,tell:[3,4],temp:2,temporari:[0,1,2],temporarili:0,test:[1,2,3,4,5],test_check_repo_exists_org_com:6,test_loc:6,testing_token:6,text:[1,3],than:[1,2,3,4,5],thank:1,thei:[0,1,2,3,4,6],them:[0,3,4],thi:[0,1,2,3,4,5,6],thing:[1,3,6],those:[5,6],through:1,time:[1,3,6],titl:0,tld:[0,1,2],tmp:1,token:[0,1,2,3,6],token_id:0,tool:[2,3,4],track:1,travi:[1,2,4,5],travis_branch:[0,4],travis_build_web_url:1,travis_pull_request:0,travis_pull_request_branch:0,travis_tag:[0,2,4],travis_token:0,tupl:0,two:[2,4],typic:2,typo:1,ument:3,unauthent:6,uncheck:6,under:1,underscor:1,unless:[1,2,6],until:5,updat:[1,5,6],upload:[0,1,2,3,4,5],upload_github_deploy_kei:0,url:[0,4],usag:2,use:[0,1,2,3,4,5,6],used:[0,1,2,3],useful:[1,4],user:[0,1,2,3,4,6],usernam:[1,3],uses:[0,1,3,5],using:[1,2],usual:0,valid:[0,1],valu:[0,1,2,6],variabl:[0,1,3,4,6],variou:1,veri:[3,6],verifi:6,version:[1,2,3,4,5],via:1,virtual:3,wai:3,wait:1,want:[1,2,3,4,5],warn:[1,2],wasn:0,websit:[3,4],welcom:[1,3],well:3,were:0,what:3,whatev:1,when:[1,3,4,6],where:[0,1,2,4],wherea:3,whether:0,which:[0,1,2,3,4,6],white:4,whitelist:[0,1,2,4],who:4,whole:1,why:3,wiki:[1,2,3],willingc:1,window:1,wish:2,within:0,without:0,won:[0,1,2],work:[1,2,3,5],worri:4,would:[1,3,4],wright:1,write:[0,1,2,3],xonsh:3,xpd:3,ylemkimon:1,yml:[1,2,3,4],you:[0,1,2,3,5,6],your:[0,2,4]},titles:["API","Doctr Changelog","Doctr Command Line Help","Doctr","Recipes","Releasing","Notes for testing doctr"],titleterms:{"2016":1,"2017":1,"2018":1,"2019":1,"new":3,Using:4,access:4,admin:4,ani:4,api:0,authent:6,branch:4,build:3,chang:1,changelog:1,com:6,command:[2,4],commit:3,configur:[2,3],deploi:[2,4],doc:4,doctr:[1,2,3,4,6],don:4,edit:3,faq:3,file:3,from:4,git:4,github:[4,6],have:4,help:2,indic:3,instal:3,line:2,local:0,major:1,master:4,minor:1,non:4,note:[3,6],org:6,page:4,post:4,privat:6,process:4,project:3,recip:4,releas:5,repo:4,repositori:6,run:3,separ:4,set:4,site:3,tabl:3,tag:4,test:6,travi:[0,3,6],usag:3,using:3,wiki:4,you:4,your:3}})