For example, consider the following workflow step:
- name: Deploy documentation to gh-pages
- if: github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/')
+ if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/rtd-theme' || startsWith(github.ref, 'refs/tags/')
shell: bash
run: |
set -x
@@ -137,7 +137,7 @@
env:
DOCS_VERSIONS_MENU_DEBUG: 'true'
DOCS_VERSIONS_MENU_VERSIONS: '(<branches> != (master, rtd-theme)), (<releases>)[:-1], rtd-theme, (<releases>)[-1], master'
- DOCS_VERSIONS_MENU_LABEL: 'rtd-theme: v0.4.1 (rtd-theme)'
+ DOCS_VERSIONS_MENU_LABEL: 'rtd-theme: v0.5.2 (rtd-theme)'
DOCS_VERSIONS_MENU_WARNING: 'unreleased: (<branches> != rtd-theme), <local-releases>'
GITHUB_ACTOR: ${{ secrets.GITHUB_ACTOR }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -312,7 +312,7 @@ Quick search
Warning
+This plugin currently relies on jQuery, which is no longer automatically included in Sphinx >= 6.0. You may need to add sphinxcontrib.jquery to the extensions list in conf.py in order for the versions menu to appear.
Showing a versions-menu in your documentation requires two steps:
Add 'docs_versions_menu' to the list of extensions in your Sphinx conf.py.
versions.json Structure"],titleterms:{"2020":4,"2021":4,"2022":4,"2023":4,"default":7,"static":2,action:2,altern:8,assumpt:7,branch:1,bug:1,code:1,comparison:8,condit:3,conduct:1,conf:9,contribut:1,credit:0,custom:6,debug:6,deploy:2,develop:1,doc:[5,6,10],doctr:[2,4],document:[1,5],download:6,exampl:7,express:3,extens:9,feedback:1,folder:[3,6],from:4,get:[1,7],github:2,group:3,guidelin:1,histori:4,html:10,index:10,instal:7,interact:2,json:11,label:6,link:6,mainten:2,menu:[4,5,6,10],messag:6,migrat:4,model:1,multivers:8,name:3,option:6,prerequisit:1,program:6,pull:1,relat:8,releas:2,report:1,request:1,set:9,slice:3,softwar:8,sort:3,specif:3,sphinx:[8,9],start:[1,7],step:[2,9],structur:11,style:1,submit:1,templat:10,test:1,theme:9,travi:2,usag:7,version:[1,4,5,6,10,11],warn:6,webhost:2,welcom:5}})
\ No newline at end of file
+Search.setIndex({docnames:["authors","contributing","deployment","folderspecs","history","index","options","readme","related_software","sphinx_extension","templates","versions_json"],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.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["authors.rst","contributing.rst","deployment.rst","folderspecs.rst","history.rst","index.rst","options.rst","readme.rst","related_software.rst","sphinx_extension.rst","templates.rst","versions_json.rst"],objects:{"docs-versions-menu":{"--debug":[6,0,1,"cmdoption-docs-versions-menu-debug"],"--default-branch":[6,0,1,"cmdoption-docs-versions-menu-default-branch"],"--downloads-file":[6,0,1,"cmdoption-docs-versions-menu-downloads-file"],"--ensure-no-jekyll":[6,0,1,"cmdoption-docs-versions-menu-ensure-no-jekyll"],"--ignore-no-jekyll":[6,0,1,"cmdoption-docs-versions-menu-ensure-no-jekyll"],"--label":[6,0,1,"cmdoption-docs-versions-menu-label"],"--latest":[6,0,1,"cmdoption-docs-versions-menu-latest"],"--no-downloads-file":[6,0,1,"cmdoption-docs-versions-menu-no-downloads-file"],"--no-write-index-html":[6,0,1,"cmdoption-docs-versions-menu-write-index-html"],"--no-write-versions-py":[6,0,1,"cmdoption-docs-versions-menu-write-versions-py"],"--outfile":[6,0,1,"cmdoption-docs-versions-menu-o"],"--suffix-latest":[6,0,1,"cmdoption-docs-versions-menu-suffix-latest"],"--version":[6,0,1,"cmdoption-docs-versions-menu-version"],"--versions":[6,0,1,"cmdoption-docs-versions-menu-versions"],"--warning":[6,0,1,"cmdoption-docs-versions-menu-warning"],"--write-index-html":[6,0,1,"cmdoption-docs-versions-menu-write-index-html"],"--write-versions-py":[6,0,1,"cmdoption-docs-versions-menu-write-versions-py"],"-o":[6,0,1,"cmdoption-docs-versions-menu-o"]}},objnames:{"0":["std","cmdoption","program option"]},objtypes:{"0":"std:cmdoption"},terms:{"2020":5,"2021":[2,5,8],"2022":5,"2023":5,"3atest":1,"440":[1,3,6,7],"break":[4,8],"case":[6,7],"class":1,"default":[3,4,5,6,8,9,10,11],"export":2,"final":3,"function":1,"import":[1,2,11],"long":1,"new":[2,4,6,10],"public":[2,3,6,10],"short":1,"static":[5,7,8,10],"switch":[2,4,7],"true":[2,6,9,10],"try":1,"var":6,"while":[4,8],Added:4,For:[1,2,4,6,7,9],That:[2,7,9],The:[1,2,3,4,6,7,8,9,10,11],Then:2,There:[1,3,7,10],These:[1,3,6],Use:2,With:9,__version__:[1,2],_build:2,_download:[2,6],_github_actions_commit_msg:2,aaron:[0,1],abl:1,about:6,abov:[1,2,3,6,7,9],absolut:9,access:[1,2],accord:[1,3,11],account:1,accross:1,achiev:4,acknowledg:0,across:8,action:[1,4,5,6,7],actual:[6,8],add:[1,2,4,7,8,9,10],adding:8,addit:[1,6,9],address:4,adher:1,adopt:[1,6],advertis:7,after:[1,2,8],again:2,against:1,aim:7,alabast:9,alexand:[0,4],all:[1,3,6,8,11],allow:[2,4],alphabet:[3,6],also:[1,2,6,7,8,9,10],altern:[5,10],although:1,alwai:1,amend:[1,2],ammend:2,among:7,analyz:7,angl:3,ani:[1,2,4,6,7,8,9],annot:[2,6],anoth:3,anyth:[6,9],api:[2,9],appear:[4,6,7,8,9,11],append:[1,6],appli:[1,6,8],appreci:1,approach:[7,8],appropri:[2,6],archiv:2,argument:6,around:1,articl:1,artifact:2,asset:2,assum:[3,6],assumpt:5,attach:[1,2],attempt:8,augment:7,authent:2,auto:2,autom:[1,2],automat:[1,2,3,4,7,8,9],avail:[1,3,4,6,7,8,9],avoid:[2,9],awesom:9,backward:[3,4],bad:10,badg:9,badge_onli:9,bar:9,base:[1,2,4,5,6,7,9],bash:2,becom:[6,8,10],befor:1,behav:6,behavior:6,behind:[2,8],being:[4,9],below:[2,3,6],best:[1,2,7,8,9],better:[2,9],between:[1,3,7,8],beyond:[1,7],big:0,bintrai:6,bisect:1,bit:1,black:1,blackcheck:1,blech:[0,4],blog:1,bodi:[2,10],bool:9,both:[4,8],bottom:[6,9],box:[7,8],bracket:3,branch:[2,3,4,6,7,8,9,10,11],branch_nam:2,browser:8,browser_download_url:2,bug:[5,6],build:[1,2,7,8],build_pdf:2,built:[2,8],call:[2,4,6],can:[1,4,6,7,9,10],candid:1,cannot:[1,8],caproto:7,cat:2,categori:6,cfg:[1,4],chang:[1,2,4,6,8],channel:[1,7],charact:1,cheat:1,check:[1,2,6,7],checkout:[1,2],christoph:0,classif:3,clean:1,cli:2,clone:[1,2,8],code:5,collect:[7,8],colon:6,com:[1,2,6,7],combin:[3,6],come:7,comma:3,command:[1,2,3,6,7,8,11],commit:[1,2,4,7],commun:1,compat:[1,4,7,8],complet:[1,9,10],con:8,conceptu:8,conda:[0,4,7],condit:5,conduct:5,conf:[4,5,7,8,10,11],config:[2,4,6],configur:[1,4,6,7,8,9],conform:[3,6],conjunct:8,consequ:4,consid:[2,4,6],consist:[3,8],contain:[1,2,3,9,10,11],content:[2,5,9,10],context:8,continu:[1,2,4,7,8],contrast:8,contribut:5,contributor:0,conveni:[1,2],convent:1,corner:[4,9],correctli:1,correspond:[3,6],cost:4,could:[1,10],count:3,coverag:1,creat:[0,1,2,6,7],creativ:8,credit:[1,5],css:[8,9],current:[4,7,8,9,10],current_fold:9,custom:[4,5,7,8,9,10],customari:3,dash:1,data:[2,6,10],debug:[1,2,5],decemb:4,deep:10,default_branch:6,defin:6,definit:6,delet:2,denot:3,depend:[2,4,7,8],deploi:[2,3,4,6,7,8],deploy:[4,5,7,8],deploy_dir:[2,7],deriv:[7,9],descript:1,design:[8,10],detail:[1,6,7],detect:9,dev0:3,dev1:1,dev:[1,2,3,4,6],develop:[0,4,5,6,7],development:3,develp:8,dict:[6,9,10],dictionari:[4,10,11],differ:[4,7,8],difficult:8,difficulti:7,direct:1,directli:[1,2,3,8],disabl:6,displai:[4,6,7,9,11],distinct:3,doc:[1,2,4,7,8,9,11],docs_versions_menu:[1,2,4,6,7,9],docs_versions_menu_:[4,6],docs_versions_menu_conf:[4,9,10],docs_versions_menu_debug:[2,6],docs_versions_menu_default_branch:6,docs_versions_menu_downloads_fil:6,docs_versions_menu_ensure_no_jekyl:6,docs_versions_menu_label:[2,6],docs_versions_menu_latest:6,docs_versions_menu_outfil:6,docs_versions_menu_suffix_latest:6,docs_versions_menu_vers:[2,6],docs_versions_menu_warn:[2,6],docs_versions_menu_write_index_html:[6,10],docs_versions_menu_write_versions_pi:[2,6],docstr:1,docsversionsmenu:2,doctest:1,doctr:[0,5,7,8],doctr_versions_menu:4,doctr_versions_menu_conf:4,doctre:2,doctyp:10,documen:4,document:[2,3,4,6,7,8,9,10],doe:1,doesn:9,don:6,down:2,download:[2,4,5,11],downloads_fil:[4,6],driven:1,drop:[4,6],due:[3,4],dure:[6,7],dynam:[7,9],each:[1,2,3,6,8,11],earli:1,earlier:2,eas:4,easi:[2,8],easier:1,easiest:2,easili:10,echo:2,effect:1,egg:7,either:[1,4],els:2,email:2,emit:4,empti:6,enabl:[2,6],enclos:3,end:[2,3],enforc:[1,8],engin:8,enhanc:4,ensur:6,ensure_no_jekyl:6,entir:[1,6,8],entireti:3,entri:6,env:[2,6],environ:[1,2,4,6,10],epub:2,equiv:10,equival:[3,4],error:1,escap:6,especi:9,essenti:7,etc:[2,3],evalu:[3,8],even:[1,2,8],everi:[1,9],everyon:1,exampl:[2,3,5,6,9,11],excel:8,except:1,exclud:3,exclus:3,exectu:4,execut:[2,4,6],exist:[2,3,4,6,10],exit:6,expand:3,expect:[1,7],explain:1,explicit:[2,6],express:5,extens:[1,2,4,5,6,7,8],extern:2,extra:1,extract:2,fail:[1,4],fals:[2,4,6,9,10],featur:1,feedstock:[0,4,7],fetch:2,field:4,file:[1,2,4,6,7,9,10,11],find:7,first:[0,1,2,4,6,11],fix:[4,7],flag:[2,6],flake8:1,flexibl:7,folder:[2,4,5,7,9,10,11],foler:6,follow:[1,2,3,4,6,7,8,9,11],font:9,forc:[1,2],forg:7,fork:[1,8],form:[1,6],format:[1,2,4,6,11],forsyth:0,forward:[4,6],found:[7,11],framework:1,free:[2,8],from:[1,2,3,5,6,7,8,9,10,11],full:[1,2,3,4,7,9],fulli:10,fundament:8,gener:[1,2,3,6,7,8,9,10,11],gerlach:0,get:[5,8],gil:0,git:[1,2,4,6,7],github:[1,4,5,6,7,8,9],github_actor:2,github_project_url:9,github_ref:2,github_sha:2,github_token:2,give:6,given:[1,2,3,6,8],goerz:[0,1,6,7],googl:1,gpg:2,greatli:1,grep:2,group:[4,5,6],guidelin:5,hand:[2,10],happen:[1,3,7],has:[4,6,7,8],have:[1,2,4,6,7,8],head:[2,10],help:[1,2],helper:7,here:[6,9],higher:3,highest:6,histor:7,histori:5,holthui:0,hook:1,host:[2,7,8,9],hoster:8,how:[1,7],howev:[2,7,9],href:10,html:[2,3,4,5,6,11],html_static_path:9,html_t:10,html_theme:9,http:[1,2,6,7,8,9,10],hugo:[0,4],ident:8,identifi:[1,6,7],ignor:[3,4,6],illustr:1,implement:[0,1],impli:9,improv:[0,1,4],includ:[1,2,3,6,7,8,9],inclus:3,incompat:8,increas:3,index:[3,4,5,6,11],info:2,inform:[6,7,8,9],inher:8,initi:[4,6],inject:[6,7,8,9],insid:[2,6],instal:[1,2,4,5],instead:[1,4,6],instruct:7,integr:[1,2,4,7,8],intend:3,intent:2,interact:[1,5],intern:[2,4,6,11],invalid:10,invok:[2,7],involv:7,irrespect:6,isort:1,isortcheck:1,issu:[1,4],issue1:1,item:[3,6,11],its:[2,3,7,8],itself:7,jan:0,javascript:[6,7,8,9],jekyl:6,jinja:[6,10],jqueri:7,js_t:[4,10,11],json:[2,4,5,6,7,9,10],json_fil:9,just:[4,7,9,10],keep:[1,4],kei:[9,11],known:11,krotov:7,label:[3,4,5,9,11],labeltempl:6,languag:[1,3],last:[1,6],later:[2,4],latest:[1,3,4,6,7,8,10,11],latex:[2,7],latter:6,lcl:7,lead:[0,3],least:4,left:[4,6,9],length:1,letter:7,like:[2,6,9],limit:[1,4,7],line:[1,3,6,7,8],link:[1,2,3,5,10],lint:1,linter:1,list:[1,3,4,6,7,10,11],littl:1,live:7,local:[1,2,3,6,8,9],log:[1,2,6],logauthor:2,logic:3,loglastlin:2,longer:[2,4,7,8],look:6,lower:[3,7,9],lowercas:6,lowest:6,mai:[1,2,3,4,6,7,8,9,10],mail:0,main:[2,3,4,6,7,11],maintain:0,mainten:[5,6],major:[1,2,4],make:[1,2,6,7],makefil:1,manag:1,mani:7,manual:[2,8],map:[6,11],march:8,markdown:[2,6],markup:1,master:[1,2,3,4,6,7,11],match:[3,6,7],matplotlib:1,mayb:6,mean:8,meaningless:3,meet:1,menu:[1,2,3,7,8,9,11],menu_titl:[4,9],merit:8,messag:[1,2,3,5],meta:10,meurer:[0,1],michael:0,michaelgoerz:0,might:[1,2,6],migrat:5,mini:3,minor:1,miss:6,modifi:[1,6],modul:1,more:[1,3,6,7,8],moreov:7,most:[4,6,8,10],motiv:[0,8],much:9,multi:8,multipl:[1,2,3,6,7,8],must:[1,6,8,9],name:[1,2,4,5,6,7,8,9,11],napoleon:1,narrow:1,navig:9,nearli:8,necessari:[1,4],need:[1,6,7,8],neg:3,nest:11,net:0,never:1,newest:6,next:1,nojekyl:6,nomeclatur:6,non:[1,6,8],none:[0,11],normal:1,notat:3,note:[1,2,3,4],now:4,number:[1,7,9],obsolet:8,obtain:2,occasion:2,offici:1,often:1,old:8,older:[4,6],oldest:6,one:[1,3,7,8],onli:[1,3,8,9],onlin:[6,7,8],open:[2,4,7,8],oper:[3,8],operand:3,option:[2,3,4,5,8,11],order:[3,4,6,7,9,11],org:[8,9],organ:1,origin:[0,1,2,8],other:[1,2,7,8,9],otherwis:6,out:[1,2,7,8],outdat:[2,3,6,7],outfil:[2,6],output:[1,2,6],outsid:[4,9],overrid:6,own:[2,8,9,11],packag:[0,1,2,4,7,8],page:[2,4,6,7,8,9,10],parenthes:3,part:[1,3,9],pass:1,patch:1,path:9,pattern:1,pcd:7,pdf:2,pennebak:[0,4],pep:[1,3,6,7],perfect:1,permiss:1,person:1,pick:[1,4,6],pin:4,pip:[1,2,7],place:[1,2,10],plain:1,plan:1,plc:7,pleas:1,plu:3,plugin:[1,7],point:1,possibl:[1,6],post1:3,post:[1,3,6],practic:[7,10],pre:[1,2,3,4,6],predecessor:7,prefer:6,prefix:[1,4],prereleas:6,present:[6,9],prevent:1,preview:1,previou:2,previous:2,primarili:8,print:2,prioriti:6,pro:8,problem:8,process:[2,4,7],produc:10,program:5,project:[0,1,2,3,4,6,7,8,9],proper:1,propos:1,provid:[0,2,7,8,9],prune:2,publish:1,purpos:2,push:[1,2,7],py36:1,py37:1,py38:1,py39:1,pyenv:1,pylint:1,pypa:1,pypars:4,pypi:1,pytest:1,python:[1,2,3,4],queri:1,quot:6,rc1:[1,3,6],read:[4,6,7,8,9],readabl:1,readi:1,readthedoc:[8,9],rebas:1,receiv:[6,10],recent:[4,6],recommend:[1,8],redirect:10,ref:2,refer:[6,9],reflect:4,refresh:10,regener:6,relas:6,relat:5,releas:[1,3,4,5,6,7,10,11],release_not:2,release_titl:2,relev:3,reli:[2,7],remedi:7,rememb:[1,2],remot:1,remov:[2,4,6],renam:4,render:[4,6,7,9,10],replac:[4,6],repo:[1,2],report:[5,6],repositori:[1,2,4,6,9],reproduc:1,requir:[1,2,4,7,8],respect:[3,7],restor:2,restrict:[1,7],restructur:1,result:[1,6,7,8,9],revers:[3,6,8,11],right:[6,9],root:[2,3,4,6,7,9,10],rst:1,rsync:2,rtd:[2,7,8,9,10],rudimentari:4,run:[1,2,4,7,8],same:[1,2,3,4,7,8],scope:1,score:1,screen:9,script:[1,2,4,6,7],secret:2,section:6,sed:2,see:[1,2,3,4,6,7,9,10,11],segment:3,select:3,self:[7,8,9],semant:1,semi:6,semicolon:6,send:1,separ:[3,6],serv:[1,9],server:[2,7],servic:2,set:[2,3,4,5,6,7,8,11],setup:[1,4,8],sever:3,share:7,sheet:1,shell:2,shorter:8,should:[1,2,3,6,7,8,11],show:[2,3,4,6,7,8],shown:[3,6,9],side:9,sign:[2,3],significantli:1,similar:7,similarli:6,simpl:1,simpler:8,simpli:[3,6],sinc:8,singl:[3,6],site:7,skip:1,slepicka:[0,4],slice:5,snippet:2,softwar:5,sole:3,solut:2,solv:8,some:[1,8],sort:[1,5],sourc:[2,4,7,8],spec:6,specif:[1,4,5,6,7,8],specifi:6,specificatin:11,sphinx:[1,2,4,5,7,10],sphinx_rtd_them:9,sphinxcontrib:[7,8],ssh:[2,7],stabl:[1,3,4,6,10,11],stage:8,standard:[3,6,7],start:[3,5],startswith:2,statu:2,step:[1,3,4,5,7],still:4,stop:4,store:6,str:9,strict:1,strictli:1,string:[1,6],strive:1,strongli:1,structur:[2,5,7,9,10],style:[8,9,10],sub:3,subfold:[1,2,8],subject:2,subset:3,suffix:[1,4,6],suffix_latest:6,suggest:0,suit:1,suitabl:6,suppli:9,support:[1,2,4,7,8,10],sure:[1,6],sympi:1,syntax:6,system:1,tabl:5,tag:[1,2,3,6,7,8],tag_nam:2,tail:2,taken:[1,9],target:[1,2],task:1,technic:3,tee:2,tell:7,templat:[4,5,6,8,9,11],templates_path:10,temporari:2,test:[8,9],test_:1,tex:2,text:[1,6,11],than:[3,6,8,9],thank:[0,4],thei:[1,3,11],them:[1,2],theme:[2,5,8],thi:[0,1,2,3,4,6,7,8,9,10],those:[2,8],three:6,through:[1,2,4,7,9],thu:[3,4,8],tied:8,time:[1,2,6,8],tip:1,titl:2,togeth:[7,9],tool:[7,8],top:[4,6],topic:1,touch:2,tox:[1,2,7],tracker:1,tradition:6,transfer:2,travi:[4,5,7,8],travis_branch:2,travis_tag:2,trigger:1,trivial:1,tupl:11,tweak:8,twincat:7,twine:1,two:[4,6,7],tyler:[0,4],type:6,typic:6,under:[4,8],underli:2,unexpectedli:6,unix:1,unless:[2,9],unmaintain:8,unreleas:[2,4,6,7],updat:[1,2,4],upgrad:4,upload:[1,2],url:[2,6,9,10,11],usag:[5,6],use:[1,2,3,6,7,9,10],used:[4,6,8,9],useful:6,user:[1,2],usernam:9,uses:[1,4,6],using:[1,2,4,6,7,9,10],usual:[6,11],util:2,valid:1,valu:[1,3,6,9,10],valuabl:0,variabl:[4,6,10],variat:1,variou:[1,3],verbos:2,version:[2,3,7,8,9],version_data:[4,10],via:[1,2,4,6],viabl:[4,8],view:[9,11],virtual:2,visual:9,volunt:1,wai:[1,2],want:[1,2,10],warn:[3,4,5,7,11],web:[1,7,8],webhost:5,webroot:[2,7],websit:1,welcom:1,well:[1,9],were:[2,4],when:[1,2,4,6,8,9,10],where:[1,3],whether:[1,6,9],which:[0,1,2,3,4,6,7,9,11],who:8,whose:[1,3],why:0,wide:8,win:1,window:1,within:[1,3,6],without:2,work:[1,7,8],workflow:[1,2,4,6,7],would:[1,6],wrap:1,write:[2,4,6,10],write_index_html:6,written:1,yet:0,yml:[2,4],you:[1,2,6,7,9,10],your:[1,2,3,4,7,9,10],zip:[2,6]},titles:["Credits","Contributing","Step 2: Deployment","Folder Specifications","History","Welcome to the Docs Versions Menu documentation","Program Options","Getting Started","Related software","Step 1: Sphinx extension","Templates","versions.json Structure"],titleterms:{"2020":4,"2021":4,"2022":4,"2023":4,"default":7,"static":2,action:2,altern:8,assumpt:7,branch:1,bug:1,code:1,comparison:8,condit:3,conduct:1,conf:9,contribut:1,credit:0,custom:6,debug:6,deploy:2,develop:1,doc:[5,6,10],doctr:[2,4],document:[1,5],download:6,exampl:7,express:3,extens:9,feedback:1,folder:[3,6],from:4,get:[1,7],github:2,group:3,guidelin:1,histori:4,html:10,index:10,instal:7,interact:2,json:11,label:6,link:6,mainten:2,menu:[4,5,6,10],messag:6,migrat:4,model:1,multivers:8,name:3,option:6,prerequisit:1,program:6,pull:1,relat:8,releas:2,report:1,request:1,set:9,slice:3,softwar:8,sort:3,specif:3,sphinx:[8,9],start:[1,7],step:[2,9],structur:11,style:1,submit:1,templat:10,test:1,theme:9,travi:2,usag:7,version:[1,4,5,6,10,11],warn:6,webhost:2,welcom:5}})
\ No newline at end of file
diff --git a/master/sphinx_extension.html b/master/sphinx_extension.html
index cd127aa..7a41297 100644
--- a/master/sphinx_extension.html
+++ b/master/sphinx_extension.html
@@ -5,7 +5,7 @@
- In your Documentation’s conf.py, add 'docs_versions_menu' to your
-extensions.
extensions.
That’s it.
See the Docs Versions Menu’s conf.py for an example.
This will inject a javascript file docs-versions-menu.js into every
@@ -85,7 +85,7 @@
html_theme
+The theme is automatically detected based on the value of html_theme
in the Sphinx conf.py file. If this is anything other than
"sphinx_rtd_theme", the badge-style versions menu is used. This implies
that in addition to the javascript file docs-versions-menu.js, a
@@ -106,13 +106,13 @@
/<project>/versions.json with <project> dynamically set based on the current Github Pages URL (https://<username>.github.io/<project>/<version>/...)
github_project_url (str): The full URL to the project on Github. By default, this is dynamically derived from the current Github Pages URL (see above).
current_folder (str): The name of the current folder. By default, dynamically set to the <version> from the current Github Pages URL (see above).
badge_only (bool): Whether to render the version menu as a “badge” in the lower right corner (defaults to True unless html_theme is "sphinx_rtd_theme")
badge_only (bool): Whether to render the version menu as a “badge” in the lower right corner (defaults to True unless html_theme is "sphinx_rtd_theme")
menu_title (str): The label to be shown in to left corner of the full versions menu (if not badge_only). Defaults to “Docs”.
Do not use the setting badge_only=False together with the
sphinx_rtd_theme. In order to avoid the badge_only.css and font files
being injected if you are using a completely custom template, do set badge_only=False
-and supply your own CSS files e.g. in a html_static_path folder.
html_static_path folder.
You may fully customize the versions menu by placing a Jinja template
file docs-versions-menu.js_t in a folder listed in your
-templates_path.
templates_path.
This template will be rendered to produce docs-versions-menu.js
using values from a dictionary docs_versions_menu_conf in your Sphinx
conf.py file.