Search.setIndex({docnames:["api","changelog","format_description","index","markup"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,sphinx:56},filenames:["api.rst","changelog.rst","format_description.rst","index.rst","markup.rst"],objects:{"":[[0,0,0,"-","nbformat"]],"nbformat.sign":[[0,2,1,"","MemorySignatureStore"],[0,2,1,"","NotebookNotary"],[0,2,1,"","SQLiteSignatureStore"],[0,2,1,"","SignatureStore"]],"nbformat.sign.NotebookNotary":[[0,4,1,"","check_cells"],[0,4,1,"","check_signature"],[0,4,1,"","mark_cells"],[0,4,1,"","sign"],[0,4,1,"","unsign"]],"nbformat.sign.SignatureStore":[[0,4,1,"","check_signature"],[0,4,1,"","close"],[0,4,1,"","remove_signature"],[0,4,1,"","store_signature"]],"nbformat.v4":[[0,3,1,"","new_code_cell"],[0,3,1,"","new_markdown_cell"],[0,3,1,"","new_notebook"],[0,3,1,"","new_output"],[0,3,1,"","new_raw_cell"],[0,3,1,"","output_from_msg"]],nbformat:[[0,1,1,"","NO_CONVERT"],[0,2,1,"","NotebookNode"],[0,2,1,"","ValidationError"],[0,3,1,"","convert"],[0,1,1,"","current_nbformat"],[0,1,1,"","current_nbformat_minor"],[0,3,1,"","from_dict"],[0,3,1,"","read"],[0,3,1,"","reads"],[0,0,0,"-","sign"],[0,0,0,"-","v4"],[0,3,1,"","validate"],[0,3,1,"","write"],[0,3,1,"","writes"]]},objnames:{"0":["py","module","Python module"],"1":["py","data","Python data"],"2":["py","class","Python class"],"3":["py","function","Python function"],"4":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:data","2":"py:class","3":"py:function","4":"py:method"},terms:{"0":[0,2,3,4],"1":[0,2,3],"2":[0,2,3],"3":3,"4":[0,2,3],"42":2,"480":2,"5":[0,2,3],"6":3,"62":1,"64":2,"640":2,"7":3,"8":3,"8601":2,"9":1,"break":1,"byte":1,"case":[0,2],"catch":1,"class":[0,1],"default":[0,1,2],"do":2,"export":1,"function":[1,3],"import":1,"int":[0,2],"n\u00e9":3,"new":[0,1,2],"null":[2,4],"return":[0,1],"short":2,"true":[0,2,4],"try":[0,1],"while":[1,2],A:[0,1,2],As:2,At:2,By:0,For:2,If:[0,2],In:[0,2],On:2,The:[0,1,4],There:[2,4],These:[0,1,2],To:[0,1],_:2,abil:1,about:[0,1,2],accept:[0,1,2],access:0,accur:1,across:2,ad:[0,1,2],add:[1,2],addit:[1,2],adopt:1,against:0,algorithm:0,all:[0,2],allow:[0,1,2],alphanumer:2,alreadi:0,also:[0,1,2],alwai:2,among:2,an:[0,1,2],ani:[0,1,2],anyth:1,api:[1,2,3],applic:[0,1,2],appveyor:1,ar:[0,1,2,3,4],arbitrari:[1,2],area:1,arg:0,argument:[0,1],as_vers:0,ascii:1,ask:1,associ:2,assum:[0,1],attach:1,attempt:2,attribut:[0,1,2],attributeerror:1,author:[1,2],auto:[1,2],automat:[0,4],autoscrol:2,avail:0,availablefont:4,avoid:1,back:[1,2],backport:2,backward:3,bar:2,base64:2,base:[0,1],basic:[1,2],becaus:2,been:[1,2],behavior:[0,4],below:[0,2],better:[1,2],between:0,biggest:1,bind:0,bodi:2,bool:[0,2],boolni:0,brian:2,broadcast:2,bug:1,build:1,built:1,bundl:2,busi:2,call:[0,1,2],can:[0,1,2],cannot:1,captur:[1,2],capture_validation_error:0,cat:1,caus:[0,1],cell:[0,1,3,4],cell_typ:2,cellid:1,center:4,chang:[3,4],channel:2,charact:2,characterist:2,check:0,check_cel:0,check_signatur:0,ci:1,clarifi:1,classic:4,close:0,code:[0,1,3],code_cel:0,codemirror:2,codemirror_mod:2,collaps:[1,2],combin:[1,2],comma:2,commit:1,common:2,commonmark:4,compar:0,compat:3,complet:2,comput:0,condit:0,configur:[0,1,3],conform:0,connect:[0,1],consist:2,construct:3,contain:[0,1,2,3],content:[0,2,3,4],context:0,continu:1,conveni:1,convers:[0,1],convert:[0,1],copi:1,core:1,correctli:1,correspond:2,could:2,cov:1,creat:[0,2],css:4,current:[0,1,2,4],current_nbformat:0,current_nbformat_minor:0,custom:2,d:0,data:[0,1,2],databas:[0,1],debug:1,defin:[1,2],definit:2,delet:[0,2],depend:[0,1],deprec:[0,1],describ:[0,2],descript:[1,2],detail:2,develop:4,dict:[0,1,2],dictionari:[0,1,2],differ:1,digest:0,directli:[1,2],discourag:1,disk:2,displai:2,displayalign:4,displayhook:2,displaymath:4,doc:[1,2],document:[0,1,2,3],doe:[0,1,2,3],doesn:0,don:1,doubl:2,downgrad:0,duck:1,due:0,dure:1,dynam:0,e:[0,2],each:[1,2,3],edit:[1,2],either:[0,2],element:1,empti:[1,2],enabl:1,enam:2,encapsul:2,encod:[1,2],end:[1,2],ensur:[0,1,2],environ:[1,2],equat:4,error:[0,1],etc:2,evalu:2,evolv:2,exampl:[0,2,4],exampleorg:2,except:2,exclud:2,execut:[1,2],execute_input:2,execute_repli:2,execute_result:1,execution_count:[1,2],exist:0,expect:[0,4],explicitli:[0,1],extens:4,extra:[0,4],fail:[0,1,2],fall:1,fals:[0,2],fast:1,fastjsonschema:1,favor:2,featur:2,fernando:2,few:[1,2,4],field:[0,1,2],file:[1,3],filenam:2,first:1,fix:[0,1],flag:1,flavor:[2,3],flit:1,follow:[0,2,4],foo:2,form:[0,1],format:[0,1],formatt:1,found:0,fp:0,frame:2,from:[0,1,2],from_dict:0,front:1,frontend:2,full:[1,2],futur:[0,1],g:0,gener:1,genutil:1,get_valid:1,github:[1,2,4],given:[0,2],go:0,granger:2,guid:4,guidelin:2,ha:[0,1],handl:[0,1],hash:[0,1],hashlib:0,have:[1,2],head:2,height:2,help:4,here:2,hexdigest:0,hide:1,highest:2,hmac:0,hold:2,how:[0,1],html:4,human:2,i:2,id:1,ident:2,idl:2,ifram:2,ignor:[0,1,2],imag:2,imagefont:4,implement:[0,1,2],improv:1,includ:[1,2],incompat:2,increas:1,increment:[0,2],index:3,indic:[0,1,2],info:1,inform:[0,1,2,4],inlin:2,inlinemath:4,input:[0,2],insid:1,instal:1,instanc:0,instead:[1,2],integ:[0,2],integr:1,intend:2,interfac:[1,4],interpret:2,introduc:1,invalid:[0,1],invers:0,io:0,iopub:[0,2],ipynb:0,ipython:[1,3],ipython_genutil:1,iso:2,isol:2,issu:1,isvalid:0,its:[0,1,2],javascript:[2,4],jep:[1,2],join:2,js:4,json:[0,1,2,3],jsonabl:[1,2],jsonschema:1,jupyt:[1,2,4],just:1,kaylees_md:2,kei:[0,2],kernel:[0,1,2],kernel_info:2,kernelspec:2,key1:2,key2:2,key3:2,know:0,known:0,kw:0,kwarg:[0,1],languag:[2,4],language_info:2,latest:0,latex:2,legal:2,length:2,less:2,level:[1,3],librari:[1,4],licens:1,like:[0,1],line:2,linebreak:4,link:1,list:[0,1,2],load:0,local:[0,1],locat:2,log:0,logic:2,longer:2,look:2,lower:2,machin:0,machineri:0,made:[0,2],mai:[0,2],maintain:0,major:[0,2],make:[0,1],mani:4,manifest:1,margin:4,mark:[0,2,4],mark_cel:0,markdown:[0,1,3],markdown_cel:0,markup:[1,3],match:[0,2],mathemat:4,mathjax:3,mathjax_displai:4,mathml:4,mean:1,meaning:1,media:3,memori:[0,1,2],memorysignaturestor:0,messag:[0,1,2],met:0,metadata:[0,1,3],method:0,mime:[1,2],mimebundl:1,minimum:1,minor:[0,1,2],miss:[0,1],mode:2,model:1,modif:4,modifi:1,modul:[0,3],more:[0,1,2,4],most:[2,4],msg:0,multi:2,multilin:2,must:[0,2],mutat:[0,1],mypi:1,name:[1,2],namespac:[1,2],nb:[0,1,2],nbdict:0,nbformat:[0,2,3],nbformat_minor:2,nbformat_valid:1,nbjson:[0,1],necessari:0,need:[0,1,2],never:0,new_code_cel:0,new_markdown_cel:0,new_notebook:0,new_output:0,new_output_cel:1,new_raw_cel:0,no_convert:0,node:0,non:0,none:[0,1],normal:[0,1],note:0,notebook:1,notebook_secur:0,notebook_signatur:0,notebooknod:[1,3],notebooknotari:0,now:1,npm:1,number:[1,2],object:[1,3],offer:1,offici:[1,2],often:2,older:1,one:[0,4],onli:[1,2],open:[0,1],oper:1,option:[0,1,2],origin:2,other:[2,3],otherwis:0,output:[0,1,3],output_from_msg:0,output_typ:[0,2],outputs_hidden:[1,2],outsid:2,overrid:0,own:[0,1],packag:[1,2],page:[1,2,3,4],paramet:[0,1],parent:0,pars:1,part:0,pass:[0,1],path:[0,1],pdf:2,perez:2,perform:0,persist:0,pick:1,place:[1,2],plain:2,pleas:0,pluggabl:[0,1],png:2,popul:1,potenti:0,pr:2,pragmat:1,pre:1,preferredfont:4,present:[0,1],preserv:2,prevent:[0,2],primari:2,print:1,prior:0,problemat:1,processenviron:4,processescap:4,produc:2,program:2,programmat:[2,3],project:1,prompt_numb:2,properti:[0,1],propos:2,provid:0,purpos:1,push:1,put:2,py:1,pyerr:2,pyout:2,pyproject:1,pytest:1,python:[1,2,3],rais:[0,1],rather:2,raw:[0,1],re:[0,2],read:[1,2,3],readabl:2,readi:2,receiv:2,recogn:2,record:[0,1],recurs:0,redund:1,ref:0,refer:[0,1,2],referenc:2,regardless:2,regress:1,relat:1,relax_add_prop:0,releas:[1,2],relev:0,remov:[0,1,2],remove_signatur:0,renam:2,render:[2,4],repair_duplicate_cell_id:0,repres:[0,2],request:[0,2],requir:[0,1,2],restructur:2,result:2,revis:0,rich:[2,3],rule:2,run:1,s:[0,1,2],save:0,schema:[0,1,2],schema_path:0,scheme:0,script:4,scroll:2,sdist:1,search:3,secur:1,see:[0,1,2,4],segment:3,self:0,serial:2,servic:1,set:[0,1,2],setup:1,shall:1,share:2,shell:2,should:[0,1,2,4],show:[0,2],shown:2,sign:0,signatur:[1,3],signaturestor:[0,1],silent:[0,1],similiar:2,simpl:[2,3],sinc:[0,2],singl:2,so:4,some:2,soon:0,sourc:[0,1,2,3],source_hidden:[1,2],spec:[1,2],special:0,specif:[0,1,2,4],specifi:[0,1,2],sphinx:2,split:2,sqlite:[0,1],sqlitesignaturestor:0,stack:1,start:[0,1,2],state:1,statement:1,statu:2,stderr:2,stdin:1,stdout:2,stem:1,step:0,still:1,stix:4,storag:1,store:[0,2,3],store_factori:0,store_signatur:0,str:[0,2],strict:[2,4],string:[0,1,2],strip_invalid_metadata:0,structur:[0,3],style:4,subclass:0,subschema:1,subset:0,subtl:1,suffici:2,suggest:1,suitabl:1,suppli:0,support:[1,2,3],sure:1,t:[0,1],tag:[1,2],take:1,target:2,tend:4,test:[1,2],tex2jax:4,text:[2,3,4],than:2,thei:[0,2,4],them:2,therefor:1,thi:[0,1,2,4],time:[1,2],timestamp:2,to_vers:0,toml:1,tool:2,top:3,traceback:2,traitlet:1,transform:1,travi:1,trust:[0,1],truthi:0,two:2,type:[0,1,3],type_check:0,typic:[0,2],ui:4,undefin:2,under:0,understand:4,unicod:[0,1],uniqu:2,unknown:0,unmodifi:2,unneed:1,unreach:1,unsaf:0,unscrol:2,unset:0,unsign:0,unspecifi:0,untrust:0,up:[1,2],updat:1,upgrad:[0,1],url:1,us:[0,1,2,4],user:[2,4],v1:0,v2:0,v3:[0,1],v4:[0,1],v5:0,valid:[0,1,2],validationerror:[0,1],validator_valu:0,valu:[0,1,2],valueerror:0,variabl:1,varieti:2,variou:2,verifi:[0,2],version:[0,1,2],version_minor:0,via:2,visibl:2,vnd:2,wa:[0,1,2],wai:1,want:0,warn:1,we:[0,1],web:[0,4],webfont:4,well:[1,2],wether:0,what:[2,3],wheel:1,when:[1,2],where:[0,1,2],whether:[0,2],which:[0,1,2],width:2,within:2,without:0,word:[0,1],work:[1,2,3],workflow:1,would:0,write:[1,3],written:2,x:[0,1,2],you:[0,2],your:[0,2]},titles:["Python API for working with notebook files","Changes in nbformat","The Notebook file format","The Jupyter Notebook Format","Supported markup formats"],titleterms:{"0":1,"1":1,"2":1,"3":1,"4":1,"5":1,"6":1,"7":1,"8":1,"function":0,The:[2,3],api:0,attach:2,backward:2,cell:2,chang:[1,2],code:2,compat:2,configur:4,construct:0,display_data:2,doe:4,error:2,execute_result:2,file:[0,2],flavor:4,format:[2,3,4],id:2,indic:3,jupyt:3,level:2,markdown:[2,4],markup:4,mathjax:4,metadata:2,nbconvert:2,nbformat:1,notebook:[0,2,3,4],notebooknod:0,object:0,other:[0,1],output:2,programmat:0,python:0,raw:2,read:0,signatur:0,storag:0,stream:2,structur:2,support:4,tabl:3,top:2,type:2,what:4,work:0,write:0}})