Sphinx GitHub Pages Generator#

+

This Repository is archived and not in active development anymore, please use the Exasol Python Toolbox instead.

-

Overview#

+

Overview#

This project provides a python library for accessing automatic generation of sphinx GitHub pages for a given repository. It is intended for the use with a Continuous Integration solution. Developed using GitHub Actions. diff --git a/main/objects.inv b/main/objects.inv index d7244c66701e03408c4004185fb80baf6464e288..09dc6f7e8ea5f300594c845f6147585a30ab8420 100644 GIT binary patch delta 551 zcmV+?0@(ep53LWdk_CU@Gblm3uWPNeUDf$=D=*IuKEgQ?gAIY!oI&Y?p1@4%$Hsdj z)t&A&&Oj*bZPFJo8mDbeeGsjHZ8(jhtW&6L1mBQ6_iD>phg+#zsq@X;wKy3~0bYiQ zNS65k6(g#`&4}I}Xt%IV2>JmXAvb6ZNKpy;JPhH8+_jfRy?TEp?3t1muW~E!m$@*C zH3MJ&*T8#P3>-&S>fXIGIK!>84|lL19u?%u6R28wKIu8Olq9ZJxRrdgy4Uu*Tv25` z$yq}iZXW3DGoSNxnmSL9sNHYHMmf*X<|JXV{c;ucnn`s1TyFl1Z@C~vtj?Y}lbtCK zJ&!fUgR3Aml%sz|wGuB0gFcKFuvDQ{ldou=&-!f45|}`2=alWek3rY?yt@Stmvg|v zE!N&kSX3qw(C1-`IwE?x4tK&{TF2YsK4XLJtk>4D-geN^KrudUa8%dZXPzBI5cfsU zNKWnwmWbFQVu>hY!63dld?z%}Ub=7TrlGI5-Nf$FP27K80iC)q3)qgYS8AwL?(EEO zW1uY_Xofv>Qh2Q?Vf#Mle+3M%kqC;3eK)iS*A{!Rhwb4~5|V)<7^y3GQ&sAF2WwK< zS&U|*G4Kup?=Ze;{D&TV52LCUYCaxo-OB%^e?6$O8|{w(8~kG5a$2@ delta 553 zcmV+^0@nSl53difk_CVK^-S0^B`;@CiFO~^S|z)x)8>7}w67+c(!V!PDYcGv@Wx~s=+zPaT zs1<7lzW%R)*R>cpj;_?bduMQlJ7^#7U|T#Y$dxBhweoz~b8IO|T&-{``Dk^o?dQ3o z%6gKshHl(E(Aj6c>ghCfo*q%V--?ZLo}oZQO1Hnd~^6t=%c-K-_le=dvBYH-KBqJ39R}WEeAD<3J@_6*RV~z*Jl49E|4aXRP-Rov9|6j<=ml!3^+#UG^WBbS rV6b}zC*2{7OKj^Yi~Tr;&!WS}vom?wH%JW-miK0Ia&qT?jkkhk`#KV) diff --git a/main/searchindex.js b/main/searchindex.js index 4918085..280a308 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["api/exasol_sphinx_github_pages_generator","api/exasol_sphinx_github_pages_generator.cli","api/exasol_sphinx_github_pages_generator.console","api/exasol_sphinx_github_pages_generator.deployer","api/exasol_sphinx_github_pages_generator.generate_index","changes/changelog","changes/changes_0.1.0","changes/changes_0.1.1","dependencies","design","developer_guide/developer_guide","index","system_requirements","user_guide/user_guide"],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/exasol_sphinx_github_pages_generator.rst","api/exasol_sphinx_github_pages_generator.cli.rst","api/exasol_sphinx_github_pages_generator.console.rst","api/exasol_sphinx_github_pages_generator.deployer.rst","api/exasol_sphinx_github_pages_generator.generate_index.rst","changes/changelog.md","changes/changes_0.1.0.md","changes/changes_0.1.1.md","dependencies.md","design.rst","developer_guide/developer_guide.rst","index.rst","system_requirements.md","user_guide/user_guide.rst"],objects:{"":[[0,0,0,"-","exasol_sphinx_github_pages_generator"]],"exasol_sphinx_github_pages_generator.console":[[2,1,1,"","Console"]],"exasol_sphinx_github_pages_generator.console.Console":[[2,2,1,"","stderr"],[2,2,1,"","stdout"]],"exasol_sphinx_github_pages_generator.deployer":[[3,1,1,"","GithubPagesDeployer"]],"exasol_sphinx_github_pages_generator.deployer.GithubPagesDeployer":[[3,2,1,"","build_and_copy_documentation"],[3,2,1,"","check_out_source_branch_as_worktree"],[3,2,1,"","checkout_target_branch_as_worktree"],[3,2,1,"","clean_worktree"],[3,2,1,"","detect_or_verify_source_branch"],[3,2,1,"","git_commit_and_push"]],"exasol_sphinx_github_pages_generator.generate_index":[[4,3,1,"","change_and_restore"],[4,3,1,"","copy_importlib_resources_dir_tree"],[4,3,1,"","copy_importlib_resources_file"],[4,3,1,"","find_index"],[4,3,1,"","generate_release_dicts"],[4,3,1,"","generate_release_index"],[4,3,1,"","get_releases"]],exasol_sphinx_github_pages_generator:[[1,0,0,"-","cli"],[2,0,0,"-","console"],[3,0,0,"-","deployer"],[4,0,0,"-","generate_index"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"0":[2,3,5,8],"1":[4,5,13],"10392":7,"11":6,"12":6,"16":7,"19":7,"2":[2,6,8],"20":6,"2022":7,"22":7,"23":7,"24":6,"26":6,"28":6,"3":[2,8,11],"34":7,"35":7,"38":7,"4":[2,7],"41":7,"42969":7,"5":6,"6":2,"7":6,"8":[7,8,11],"break":10,"byte":2,"class":[2,3,13],"default":[2,3,10,11,13],"do":10,"function":[3,4,13],"import":[8,13],"int":3,"new":[2,3,6,9,11],"return":[3,4],"switch":3,"true":[2,3,13],A:[3,8],As:10,At:11,By:2,For:[4,9,10,11,13],If:[3,9,10,12,13],In:[4,10,13],It:[6,10,11,12,13],The:[2,3,4,7,8,9,10,12,13],Then:[10,13],There:10,These:10,To:[9,10,11,13],Will:[3,13],__main__:13,__name__:13,_sourc:4,abc:4,abort:4,abov:8,access:[8,10,11],accordingli:13,achiev:9,action:[6,7,10,11],ad:[2,3,6,7,12],add:[3,4,9,11],addit:[4,11],addition:[4,9],adher:11,adjust:[7,13],affect:7,after:[2,3,10],aim:11,alert:7,all:[3,4,6,9,11,13],alreadi:[3,4,10],also:[3,4,6,9,10,11,13],altern:13,alwai:2,an:[2,3,4,6,10,13],ani:[2,4,9],anoth:13,ansi:2,apach:8,api:[9,13],apidoc:[3,13],appropri:[10,11],ar:[2,3,4,9,10,11,13],argument:7,argv:13,artefact:[10,13],assert:7,autoclass:13,autodoc:12,autoexcept:13,autom:8,automat:[6,9,11,12,13],automodul:13,autosummari:13,avail:10,avoid:9,b:[9,13],bad:4,base:[2,3,13],becaus:[2,4,7,11,13],befor:[4,9],being:13,below:13,benefit:11,better:2,binari:2,bit:11,bool:[2,3,4,7,13],both:10,branch:[3,4,6,10,11,13],browser:13,bsd:8,bucketf:6,build:[3,6,7,9,11],build_and_copy_document:3,build_dir:9,built:[9,10,11],call:[3,4,6,9],can:[3,6,9,10,11,12,13],caus:[3,13],certifi:7,chang:[2,3,7,9,10,11,13],change_and_restor:4,check:[3,4,7,9],check_documentation_build:10,check_out_source_branch_as_worktre:3,checkout_target_branch_as_worktre:3,choos:11,ci:[9,11],claus:8,clean:[8,9,10,13],clean_worktre:3,cli:[0,7,13],click:[2,7,8,13],clirunn:13,clone:10,clutter:12,code:[2,6,7,9,11,13],color:2,colorama:2,com:[6,7,10,11],command:[3,8,13],comment:[9,12],commit:[3,6,9,10,11,13],commitid:[3,13],compar:2,compat:13,conf:[3,13],configur:13,confus:10,consist:9,consol:0,contain:[4,9,11,13],continu:11,contributor:11,convert:2,copi:[3,4,9],copy_importlib_resources_dir_tre:4,copy_importlib_resources_fil:4,corrupt:12,creat:[3,6,8,9,11,12],creation:8,cross:[11,13],current:[3,4,9,10,13],current_commit_id:[3,13],currentworkdir:9,customis:8,cve:7,d:9,data:2,date:3,deal:9,debug:13,decid:[9,11,12],decis:11,declar:13,delet:[3,9,10],denot:4,depend:[7,10,11],dependabot:7,deploi:[3,13],deploy:[0,13],deploy_github_pag:13,describ:[3,10],design:11,destin:4,detail:13,detect:3,detect_or_verify_source_branch:3,dev:7,develop:11,dict:4,dictionari:4,differ:[2,3,11],dir:[4,13],direct:13,directli:[12,13],directori:[3,4,9,11,13],doc:[9,10,13],docstr:13,doctre:9,docu:13,document:[3,4,8],doe:[2,3],doesn:[9,11],don:[10,11],dure:[9,11],e:[9,11,13],each:[4,9,10,11],egg:11,els:3,empti:[7,13],enabl:[2,7,13],encod:2,end:4,engin:8,ensur:[2,3,9,11],entrypoint:6,env:7,environ:[2,8,10,13],equal:3,err:2,error:3,exactli:4,exampl:[3,10,13],exasol:[6,10,11],exasol_sphinx_github_pages_gener:13,except:13,exist:[3,4,6,9,10,11,12,13],exit:[3,13],expect:[9,11],explain:10,explan:13,fail:[3,7],fals:2,featur:[8,10],file:[2,3,4,6,8,9,10,11,12,13],find:[3,4,9,10,13],find_index:4,finish:3,first:[3,4,10],fit:[9,11],flag:[3,13],flavor:8,flush:2,folder:[9,10,12,13],follow:2,forc:2,format:12,found:[4,10],framework:8,from:[3,4,6,7,8,9,11,12,13],fulfil:11,full:[8,13],furo:[4,8,11],furthermor:13,gener:[3,4,8,10],generate_index:[0,3],generate_release_dict:4,generate_release_index:4,get:12,get_releas:4,gh:7,git:[3,10,11,13],git_commit_and_push:3,github:[3,10,13],githubpag:6,githubpagesdeploy:[3,13],gitpython:7,give:4,given:[3,4,11,13],go:10,got:10,guid:11,ha:[3,11,13],have:[9,10,11,13],help:13,here:[10,13],hide:2,host:11,how:10,howev:9,html:[3,4,6,9,11,12,13],http:[6,7,10],id:[7,9],ignor:[3,13],immedi:10,implement:6,importlib:8,importlib_resourc:[4,7],includ:[12,13],incorrect:6,index:[3,4,6,11,13],indic:3,inform:[11,12],initi:[6,9,11],insid:[3,13],instal:[2,7,13],instead:[2,3,4,13],integr:11,intend:11,interact:2,interfac:8,intermedi:[9,12],intermediate_dir:9,invok:13,io:2,issu:7,its:[3,4],itself:[7,10],jinja2:8,just:13,keep:9,kept:3,kit:8,l:10,languag:13,latest:[4,7,11],least:13,less:4,leverag:8,librari:[7,8,11],licens:8,like:[2,7,10,13],line:[3,8,13],link:[6,11,13],linux:2,list:[3,4,6,7,9,13],local:[3,9],locat:[4,10],log:7,look:2,lot:9,machin:10,main:[9,10,11,13],manual:10,mark:10,markdown:[7,8,11],markedli:8,mausernam:10,mauserpat:10,messag:[2,13],minim:13,misconfigur:2,miss:6,mit:8,modifi:2,modul:[8,11,13],module_path:[3,9,13],moment:11,more:4,move:6,multipl:[7,8,11],myst:[8,11],name:[3,4,6,7,9,10,11,13],need:[9,10,11],nest:4,newlin:2,nl:2,none:[2,3,4],nor:7,normal:13,noth:3,nox:[7,8,10,13],noxfil:[10,13],o:[9,13],object:[2,3,4,13],occur:3,often:9,older:3,onc:13,one:[4,11,12],onli:[4,13],open:[10,13],option:[2,6],order:[3,4,9,10],origin:[3,13],original_workdir:3,other:[2,3,13],otherwis:[3,13],our:[7,11,13],out:[3,4,9,10],output:[2,7],output_dir:3,over:13,overview:13,own:10,packag:[3,8,9,11,12,13],page:[3,10,12,13],paramet:[2,3,4,6,7,9,13],pars:[7,8],parser:[8,11],part:[4,13],pass:13,password:10,path1:13,path2:13,path:[3,4,7,13],pathlib:[3,4,13],person:10,pip:11,plain:13,pleas:[4,13],plugin:13,poe:7,poetri:[7,10],point:[3,4],possibl:12,prefer:3,prepar:11,present:9,print:[2,13],privat:10,process:[9,10,11],program:[3,13],project:[4,6,7,9,10,11,13],proper:13,provid:[2,6,8,11,13],psf:8,publish:[9,10,11],pull:7,purpos:[8,13],push:[3,6,7,9,10,11,12,13],push_en:[3,13],push_origin:[3,13],put:[4,13],py:[3,7,10,13],pygithub:9,pytest:[7,8],python3:13,python:[6,8,11,12,13],quickstart:13,readi:10,recurs:13,redo:7,ref:[3,13],refer:13,reflect:7,rel:4,releas:[3,4,10,11],release_list:4,relock:7,remot:[3,4,11,12,13],remov:[2,4,7],replac:7,repositori:[3,4,9,10,11,12],repository_root:13,repres:4,requir:[9,11],reset:3,resid:[3,13],resourc:8,respect:10,restructuredtext:[11,13],result:[3,4,9,13],rewrot:6,root:[4,9,10,11,13],rst:[3,13],run:[3,9,10,13],runner:10,s:[8,10,13],scr_path:4,script:[6,13],search:[4,7,11],secret:6,see:13,select:6,self:3,separ:[3,9],set:[3,9,10,11,13],setup:7,setup_test_repo:10,sgpg:13,sh:6,shortcut:13,shorthand:13,should:[2,3,4,7,9,12,13],show:[2,13],signatur:[9,12],similar:13,simplif:11,sinc:9,slash:4,so:[2,9,10,11,12],softwar:[8,11],solut:11,sourc:[3,4,6,8,9,10,11,12,13],source_branch:[3,4,9,13],source_branch_exists_loc:3,source_dir:[3,6,13],source_origin:[3,6,13],source_worktre:3,specif:[9,10,13],specifi:10,sphinx:[3,8,9,10,12],sphinx_github:11,src_file:4,src_path:4,stai:9,stash:3,state:3,stderr:2,stdout:[2,13],step:11,still:2,str:[3,4,13],string:[2,4,7],stringarrai:13,structur:[8,9,11],stub:13,style:2,subprocess:9,support:[2,6,11,13],sy:[2,13],system:8,t:[9,10,11,13],tag:[3,6,7,9,11,13],tag_nam:[3,13],take:4,target:[3,6,10,13],target_branch:[3,4,13],target_branch_exists_remot:4,target_fil:4,target_path:4,target_worktre:4,task:[9,10,13],tbd:7,te:13,tempdir:[3,13],templat:[4,8],temporari:[3,4,9,12,13],temporarili:9,termin:[2,9],test:[6,7],test_packag:13,text:[2,8,13],than:4,them:[3,4,9,10,13],theme:[4,8,11],therefor:[4,13],thi:[2,3,4,6,8,9,10,11,13],titl:4,toctre:13,token:10,toml:8,tool:[8,11,13],traceback:13,track:7,travers:4,tree:4,tri:3,trigger:6,unaffect:7,uncommit:[3,9],unicod:2,union:4,unnecessari:12,unnecessarili:12,unpush:[3,13],up:[3,4],updat:[7,9,10,11],us:[2,3,4,6,7,10,11,12,13],usag:[6,13],user:[10,11],usual:11,util:6,valid:[3,10],variabl:10,version:[2,3,6,8,9,11],via:[6,7,11],vulner:7,w:[9,13],wa:12,wai:3,want:13,we:[4,9,10,11,13],wheel:7,when:13,where:[3,12,13],whether:[4,11],which:[9,10,11,12,13],whole:9,whose:4,window:2,within:8,without:9,work:[3,6,11,13],workflow:[6,7,10],worktre:[3,4,9],worktree_path:3,write:2,yaml:10,you:[3,10,11,13],your:[4,10,13],your_caller_script:13},titles:["exasol_sphinx_github_pages_generator package","exasol_sphinx_github_pages_generator.cli module","exasol_sphinx_github_pages_generator.console module","exasol_sphinx_github_pages_generator.deployer module","exasol_sphinx_github_pages_generator.generate_index module","Changes","Sphinx GitHub Pages Generator 0.1.0, released 2022-06-15","Sphinx GitHub Pages Generator 0.1.1, released YYYY-MM-DD","Dependencies","Design Decisions:","Developer Guide","Sphinx GitHub Pages Generator","Requirements this Software aims to fulfill:","User Guide"],titleterms:{"0":[6,7],"06":6,"1":[6,7],"15":6,"2022":6,In:11,add:12,aim:12,an:[9,12],api:11,apidoc:[9,12],branch:[9,12],bug:[6,7],build:[10,13],call:13,chang:5,ci:10,cli:1,consol:2,content:[0,11],dd:7,decis:9,depend:8,deploy:3,design:9,develop:10,document:[6,7,9,10,11,12,13],enhanc:[6,7],exasol_sphinx_github_pages_gener:[0,1,2,3,4],featur:[6,7,11],fix:[6,7],fulfil:12,gener:[6,7,9,11,12,13],generate_index:4,git:9,github:[6,7,9,11,12],guid:[10,13],indic:11,instal:[10,11],isol:[9,12],local:13,mm:7,modul:[0,1,2,3,4],motiv:11,need:13,nutshel:11,option:13,overview:11,packag:0,page:[6,7,9,11],prerequisit:11,refactor:[6,7],refer:11,releas:[6,7],repositori:13,requir:12,run:8,secur:[6,7],select:[9,12],setup:10,softwar:12,sphinx:[6,7,11,13],structur:13,submodul:0,summari:[6,7],tabl:11,test:[8,10,13],thi:12,time:8,us:9,user:13,work:[9,12],workspac:[9,12],yyyi:7}}) \ No newline at end of file +Search.setIndex({docnames:["api/exasol_sphinx_github_pages_generator","api/exasol_sphinx_github_pages_generator.cli","api/exasol_sphinx_github_pages_generator.console","api/exasol_sphinx_github_pages_generator.deployer","api/exasol_sphinx_github_pages_generator.generate_index","changes/changelog","changes/changes_0.1.0","changes/changes_0.1.1","dependencies","design","developer_guide/developer_guide","index","system_requirements","user_guide/user_guide"],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/exasol_sphinx_github_pages_generator.rst","api/exasol_sphinx_github_pages_generator.cli.rst","api/exasol_sphinx_github_pages_generator.console.rst","api/exasol_sphinx_github_pages_generator.deployer.rst","api/exasol_sphinx_github_pages_generator.generate_index.rst","changes/changelog.md","changes/changes_0.1.0.md","changes/changes_0.1.1.md","dependencies.md","design.rst","developer_guide/developer_guide.rst","index.rst","system_requirements.md","user_guide/user_guide.rst"],objects:{"":[[0,0,0,"-","exasol_sphinx_github_pages_generator"]],"exasol_sphinx_github_pages_generator.console":[[2,1,1,"","Console"]],"exasol_sphinx_github_pages_generator.console.Console":[[2,2,1,"","stderr"],[2,2,1,"","stdout"]],"exasol_sphinx_github_pages_generator.deployer":[[3,1,1,"","GithubPagesDeployer"]],"exasol_sphinx_github_pages_generator.deployer.GithubPagesDeployer":[[3,2,1,"","build_and_copy_documentation"],[3,2,1,"","check_out_source_branch_as_worktree"],[3,2,1,"","checkout_target_branch_as_worktree"],[3,2,1,"","clean_worktree"],[3,2,1,"","detect_or_verify_source_branch"],[3,2,1,"","git_commit_and_push"]],"exasol_sphinx_github_pages_generator.generate_index":[[4,3,1,"","change_and_restore"],[4,3,1,"","copy_importlib_resources_dir_tree"],[4,3,1,"","copy_importlib_resources_file"],[4,3,1,"","find_index"],[4,3,1,"","generate_release_dicts"],[4,3,1,"","generate_release_index"],[4,3,1,"","get_releases"]],exasol_sphinx_github_pages_generator:[[1,0,0,"-","cli"],[2,0,0,"-","console"],[3,0,0,"-","deployer"],[4,0,0,"-","generate_index"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"0":[2,3,5,8],"1":[4,5,13],"10392":7,"11":6,"12":6,"16":7,"19":7,"2":[2,6,8],"20":6,"2022":7,"22":7,"23":7,"24":6,"26":6,"28":6,"3":[2,8,11],"34":7,"35":7,"38":7,"4":[2,7],"41":7,"42969":7,"5":6,"6":2,"7":6,"8":[7,8,11],"break":10,"byte":2,"class":[2,3,13],"default":[2,3,10,11,13],"do":10,"function":[3,4,13],"import":[8,13],"int":3,"new":[2,3,6,9,11],"return":[3,4],"switch":3,"true":[2,3,13],A:[3,8],As:10,At:11,By:2,For:[4,9,10,11,13],If:[3,9,10,12,13],In:[4,10,13],It:[6,10,11,12,13],The:[2,3,4,7,8,9,10,12,13],Then:[10,13],There:10,These:10,To:[9,10,11,13],Will:[3,13],__main__:13,__name__:13,_sourc:4,abc:4,abort:4,abov:8,access:[8,10,11],accordingli:13,achiev:9,action:[6,7,10,11],activ:11,ad:[2,3,6,7,12],add:[3,4,9,11],addit:[4,11],addition:[4,9],adher:11,adjust:[7,13],affect:7,after:[2,3,10],aim:11,alert:7,all:[3,4,6,9,11,13],alreadi:[3,4,10],also:[3,4,6,9,10,11,13],altern:13,alwai:2,an:[2,3,4,6,10,13],ani:[2,4,9],anoth:13,ansi:2,anymor:11,apach:8,api:[9,13],apidoc:[3,13],appropri:[10,11],ar:[2,3,4,9,10,11,13],archiv:11,argument:7,argv:13,artefact:[10,13],assert:7,autoclass:13,autodoc:12,autoexcept:13,autom:8,automat:[6,9,11,12,13],automodul:13,autosummari:13,avail:10,avoid:9,b:[9,13],bad:4,base:[2,3,13],becaus:[2,4,7,11,13],befor:[4,9],being:13,below:13,benefit:11,better:2,binari:2,bit:11,bool:[2,3,4,7,13],both:10,branch:[3,4,6,10,11,13],browser:13,bsd:8,bucketf:6,build:[3,6,7,9,11],build_and_copy_document:3,build_dir:9,built:[9,10,11],call:[3,4,6,9],can:[3,6,9,10,11,12,13],caus:[3,13],certifi:7,chang:[2,3,7,9,10,11,13],change_and_restor:4,check:[3,4,7,9],check_documentation_build:10,check_out_source_branch_as_worktre:3,checkout_target_branch_as_worktre:3,choos:11,ci:[9,11],claus:8,clean:[8,9,10,13],clean_worktre:3,cli:[0,7,13],click:[2,7,8,13],clirunn:13,clone:10,clutter:12,code:[2,6,7,9,11,13],color:2,colorama:2,com:[6,7,10,11],command:[3,8,13],comment:[9,12],commit:[3,6,9,10,11,13],commitid:[3,13],compar:2,compat:13,conf:[3,13],configur:13,confus:10,consist:9,consol:0,contain:[4,9,11,13],continu:11,contributor:11,convert:2,copi:[3,4,9],copy_importlib_resources_dir_tre:4,copy_importlib_resources_fil:4,corrupt:12,creat:[3,6,8,9,11,12],creation:8,cross:[11,13],current:[3,4,9,10,13],current_commit_id:[3,13],currentworkdir:9,customis:8,cve:7,d:9,data:2,date:3,deal:9,debug:13,decid:[9,11,12],decis:11,declar:13,delet:[3,9,10],denot:4,depend:[7,10,11],dependabot:7,deploi:[3,13],deploy:[0,13],deploy_github_pag:13,describ:[3,10],design:11,destin:4,detail:13,detect:3,detect_or_verify_source_branch:3,dev:7,develop:11,dict:4,dictionari:4,differ:[2,3,11],dir:[4,13],direct:13,directli:[12,13],directori:[3,4,9,11,13],doc:[9,10,13],docstr:13,doctre:9,docu:13,document:[3,4,8],doe:[2,3],doesn:[9,11],don:[10,11],dure:[9,11],e:[9,11,13],each:[4,9,10,11],egg:11,els:3,empti:[7,13],enabl:[2,7,13],encod:2,end:4,engin:8,ensur:[2,3,9,11],entrypoint:6,env:7,environ:[2,8,10,13],equal:3,err:2,error:3,exactli:4,exampl:[3,10,13],exasol:[6,10,11],exasol_sphinx_github_pages_gener:13,except:13,exist:[3,4,6,9,10,11,12,13],exit:[3,13],expect:[9,11],explain:10,explan:13,fail:[3,7],fals:2,featur:[8,10],file:[2,3,4,6,8,9,10,11,12,13],find:[3,4,9,10,13],find_index:4,finish:3,first:[3,4,10],fit:[9,11],flag:[3,13],flavor:8,flush:2,folder:[9,10,12,13],follow:2,forc:2,format:12,found:[4,10],framework:8,from:[3,4,6,7,8,9,11,12,13],fulfil:11,full:[8,13],furo:[4,8,11],furthermor:13,gener:[3,4,8,10],generate_index:[0,3],generate_release_dict:4,generate_release_index:4,get:12,get_releas:4,gh:7,git:[3,10,11,13],git_commit_and_push:3,github:[3,10,13],githubpag:6,githubpagesdeploy:[3,13],gitpython:7,give:4,given:[3,4,11,13],go:10,got:10,guid:11,ha:[3,11,13],have:[9,10,11,13],help:13,here:[10,13],hide:2,host:11,how:10,howev:9,html:[3,4,6,9,11,12,13],http:[6,7,10],id:[7,9],ignor:[3,13],immedi:10,implement:6,importlib:8,importlib_resourc:[4,7],includ:[12,13],incorrect:6,index:[3,4,6,11,13],indic:3,inform:[11,12],initi:[6,9,11],insid:[3,13],instal:[2,7,13],instead:[2,3,4,11,13],integr:11,intend:11,interact:2,interfac:8,intermedi:[9,12],intermediate_dir:9,invok:13,io:2,issu:7,its:[3,4],itself:[7,10],jinja2:8,just:13,keep:9,kept:3,kit:8,l:10,languag:13,latest:[4,7,11],least:13,less:4,leverag:8,librari:[7,8,11],licens:8,like:[2,7,10,13],line:[3,8,13],link:[6,11,13],linux:2,list:[3,4,6,7,9,13],local:[3,9],locat:[4,10],log:7,look:2,lot:9,machin:10,main:[9,10,11,13],manual:10,mark:10,markdown:[7,8,11],markedli:8,mausernam:10,mauserpat:10,messag:[2,13],minim:13,misconfigur:2,miss:6,mit:8,modifi:2,modul:[8,11,13],module_path:[3,9,13],moment:11,more:4,move:6,multipl:[7,8,11],myst:[8,11],name:[3,4,6,7,9,10,11,13],need:[9,10,11],nest:4,newlin:2,nl:2,none:[2,3,4],nor:7,normal:13,noth:3,nox:[7,8,10,13],noxfil:[10,13],o:[9,13],object:[2,3,4,13],occur:3,often:9,older:3,onc:13,one:[4,11,12],onli:[4,13],open:[10,13],option:[2,6],order:[3,4,9,10],origin:[3,13],original_workdir:3,other:[2,3,13],otherwis:[3,13],our:[7,11,13],out:[3,4,9,10],output:[2,7],output_dir:3,over:13,overview:13,own:10,packag:[3,8,9,11,12,13],page:[3,10,12,13],paramet:[2,3,4,6,7,9,13],pars:[7,8],parser:[8,11],part:[4,13],pass:13,password:10,path1:13,path2:13,path:[3,4,7,13],pathlib:[3,4,13],person:10,pip:11,plain:13,pleas:[4,11,13],plugin:13,poe:7,poetri:[7,10],point:[3,4],possibl:12,prefer:3,prepar:11,present:9,print:[2,13],privat:10,process:[9,10,11],program:[3,13],project:[4,6,7,9,10,11,13],proper:13,provid:[2,6,8,11,13],psf:8,publish:[9,10,11],pull:7,purpos:[8,13],push:[3,6,7,9,10,11,12,13],push_en:[3,13],push_origin:[3,13],put:[4,13],py:[3,7,10,13],pygithub:9,pytest:[7,8],python3:13,python:[6,8,11,12,13],quickstart:13,readi:10,recurs:13,redo:7,ref:[3,13],refer:13,reflect:7,rel:4,releas:[3,4,10,11],release_list:4,relock:7,remot:[3,4,11,12,13],remov:[2,4,7],replac:7,repositori:[3,4,9,10,11,12],repository_root:13,repres:4,requir:[9,11],reset:3,resid:[3,13],resourc:8,respect:10,restructuredtext:[11,13],result:[3,4,9,13],rewrot:6,root:[4,9,10,11,13],rst:[3,13],run:[3,9,10,13],runner:10,s:[8,10,13],scr_path:4,script:[6,13],search:[4,7,11],secret:6,see:13,select:6,self:3,separ:[3,9],set:[3,9,10,11,13],setup:7,setup_test_repo:10,sgpg:13,sh:6,shortcut:13,shorthand:13,should:[2,3,4,7,9,12,13],show:[2,13],signatur:[9,12],similar:13,simplif:11,sinc:9,slash:4,so:[2,9,10,11,12],softwar:[8,11],solut:11,sourc:[3,4,6,8,9,10,11,12,13],source_branch:[3,4,9,13],source_branch_exists_loc:3,source_dir:[3,6,13],source_origin:[3,6,13],source_worktre:3,specif:[9,10,13],specifi:10,sphinx:[3,8,9,10,12],sphinx_github:11,src_file:4,src_path:4,stai:9,stash:3,state:3,stderr:2,stdout:[2,13],step:11,still:2,str:[3,4,13],string:[2,4,7],stringarrai:13,structur:[8,9,11],stub:13,style:2,subprocess:9,support:[2,6,11,13],sy:[2,13],system:8,t:[9,10,11,13],tag:[3,6,7,9,11,13],tag_nam:[3,13],take:4,target:[3,6,10,13],target_branch:[3,4,13],target_branch_exists_remot:4,target_fil:4,target_path:4,target_worktre:4,task:[9,10,13],tbd:7,te:13,tempdir:[3,13],templat:[4,8],temporari:[3,4,9,12,13],temporarili:9,termin:[2,9],test:[6,7],test_packag:13,text:[2,8,13],than:4,them:[3,4,9,10,13],theme:[4,8,11],therefor:[4,13],thi:[2,3,4,6,8,9,10,11,13],titl:4,toctre:13,token:10,toml:8,tool:[8,11,13],toolbox:11,traceback:13,track:7,travers:4,tree:4,tri:3,trigger:6,unaffect:7,uncommit:[3,9],unicod:2,union:4,unnecessari:12,unnecessarili:12,unpush:[3,13],up:[3,4],updat:[7,9,10,11],us:[2,3,4,6,7,10,11,12,13],usag:[6,13],user:[10,11],usual:11,util:6,valid:[3,10],variabl:10,version:[2,3,6,8,9,11],via:[6,7,11],vulner:7,w:[9,13],wa:12,wai:3,want:13,we:[4,9,10,11,13],wheel:7,when:13,where:[3,12,13],whether:[4,11],which:[9,10,11,12,13],whole:9,whose:4,window:2,within:8,without:9,work:[3,6,11,13],workflow:[6,7,10],worktre:[3,4,9],worktree_path:3,write:2,yaml:10,you:[3,10,11,13],your:[4,10,13],your_caller_script:13},titles:["exasol_sphinx_github_pages_generator package","exasol_sphinx_github_pages_generator.cli module","exasol_sphinx_github_pages_generator.console module","exasol_sphinx_github_pages_generator.deployer module","exasol_sphinx_github_pages_generator.generate_index module","Changes","Sphinx GitHub Pages Generator 0.1.0, released 2022-06-15","Sphinx GitHub Pages Generator 0.1.1, released YYYY-MM-DD","Dependencies","Design Decisions:","Developer Guide","Sphinx GitHub Pages Generator","Requirements this Software aims to fulfill:","User Guide"],titleterms:{"0":[6,7],"06":6,"1":[6,7],"15":6,"2022":6,In:11,add:12,aim:12,an:[9,12],api:11,apidoc:[9,12],branch:[9,12],bug:[6,7],build:[10,13],call:13,chang:5,ci:10,cli:1,consol:2,content:[0,11],dd:7,decis:9,depend:8,deploy:3,design:9,develop:10,document:[6,7,9,10,11,12,13],enhanc:[6,7],exasol_sphinx_github_pages_gener:[0,1,2,3,4],featur:[6,7,11],fix:[6,7],fulfil:12,gener:[6,7,9,11,12,13],generate_index:4,git:9,github:[6,7,9,11,12],guid:[10,13],indic:11,instal:[10,11],isol:[9,12],local:13,mm:7,modul:[0,1,2,3,4],motiv:11,need:13,nutshel:11,option:13,overview:11,packag:0,page:[6,7,9,11],prerequisit:11,refactor:[6,7],refer:11,releas:[6,7],repositori:13,requir:12,run:8,secur:[6,7],select:[9,12],setup:10,softwar:12,sphinx:[6,7,11,13],structur:13,submodul:0,summari:[6,7],tabl:11,test:[8,10,13],thi:12,time:8,us:9,user:13,work:[9,12],workspac:[9,12],yyyi:7}}) \ No newline at end of file diff --git a/main/user_guide/user_guide.html b/main/user_guide/user_guide.html index 17baf09..4150e8a 100644 --- a/main/user_guide/user_guide.html +++ b/main/user_guide/user_guide.html @@ -354,7 +354,7 @@

Options
-class exasol_sphinx_github_pages_generator.deployer.GithubPagesDeployer(source_dir: pathlib.Path, source_branch: str, source_origin: str, current_commit_id: str, module_path: list, target_branch: str, push_origin: str, push_enabled: bool, tempdir: pathlib.Path)
+class exasol_sphinx_github_pages_generator.deployer.GithubPagesDeployer(source_dir: pathlib.Path, source_branch: str, source_origin: str, current_commit_id: str, module_path: list, target_branch: str, push_origin: str, push_enabled: bool, tempdir: pathlib.Path)

Builds and deploys GitHub Pages using Sphinx given a branch.

Parameters