From fe38d4fce578b79bf939e9c921397fa1a7b06786 Mon Sep 17 00:00:00 2001 From: Andrew Belt Date: Fri, 16 Apr 2021 00:03:39 -0400 Subject: [PATCH] Remove Sphinx stuff. Add index and toc articles. --- Makefile | 16 --- _static/MyModule.svg | 229 -------------------------------------- _static/overrides.css | 13 --- _templates/layout.html | 12 -- _templates/searchbox.html | 0 conf.py | 105 ----------------- favicon.png | Bin 5783 -> 0 bytes index.md | 1 + index.rst | 52 --------- toc.md | 27 +++++ 10 files changed, 28 insertions(+), 427 deletions(-) delete mode 100644 Makefile delete mode 100644 _static/MyModule.svg delete mode 100644 _static/overrides.css delete mode 100644 _templates/layout.html delete mode 100644 _templates/searchbox.html delete mode 100644 conf.py delete mode 100644 favicon.png create mode 100644 index.md delete mode 100644 index.rst create mode 100644 toc.md diff --git a/Makefile b/Makefile deleted file mode 100644 index 8ee23c1..0000000 --- a/Makefile +++ /dev/null @@ -1,16 +0,0 @@ -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SOURCEDIR = . -BUILDDIR = _build - - -all: html - -serve: html - http-server _build/html - -upload: html - rsync _build/html/ vcvrack.com:vcvrack.com/manual/ -ruvz --delete - -%: - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) diff --git a/_static/MyModule.svg b/_static/MyModule.svg deleted file mode 100644 index 89d5a31..0000000 --- a/_static/MyModule.svg +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/_static/overrides.css b/_static/overrides.css deleted file mode 100644 index 7bc88c9..0000000 --- a/_static/overrides.css +++ /dev/null @@ -1,13 +0,0 @@ -@import url('https://cloud.typography.com/7479438/7888212/css/fonts.css'); - -body, h1, h2, .rst-content .toctree-wrapper p.caption, h3, h4, h5, h6, legend { - font-family: "Gotham Rounded A", "Gotham Rounded B", sans-serif; -} - -.wy-side-nav-search { - background-color: transparent; -} - -.wy-nav-content { - max-width: 1000px; -} diff --git a/_templates/layout.html b/_templates/layout.html deleted file mode 100644 index b59e2ee..0000000 --- a/_templates/layout.html +++ /dev/null @@ -1,12 +0,0 @@ -{% extends "!layout.html" %} - -{% block extrahead %}{{ super() }} - - -{% endblock %} \ No newline at end of file diff --git a/_templates/searchbox.html b/_templates/searchbox.html deleted file mode 100644 index e69de29..0000000 diff --git a/conf.py b/conf.py deleted file mode 100644 index c0bce61..0000000 --- a/conf.py +++ /dev/null @@ -1,105 +0,0 @@ - -project = 'VCV Rack' -copyright = '2020, VCV' -author = 'VCV' - -source_encoding = 'utf-8' - -extensions = [ - 'sphinx.ext.mathjax', - 'recommonmark', -] - -from recommonmark.parser import CommonMarkParser -from recommonmark.transform import AutoStructify - -source_parsers = { - '.md': CommonMarkParser, -} - -source_suffix = ['.rst', '.md'] - -templates_path = ['_templates'] - -master_doc = 'index' - -language = 'en' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path . -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - - -# Theme - -html_favicon = "favicon.png" - -html_theme = "sphinx_rtd_theme" - -html_theme_options = { - 'logo_only': True, # if we have a html_logo below, this shows /only/ the logo with no title text - 'collapse_navigation': False, # Collapse navigation (False makes it tree-like) -} - -html_context = { - "display_github": True, - "github_user": "VCVRack", - "github_repo": "manual", - "github_version": "master", - "conf_py_path": "/", -} - -html_logo = 'images/logo.png' - -html_static_path = ['_static'] - -html_show_sphinx = False -html_show_copyright = False - -htmlhelp_basename = 'VCVRackdoc' - - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -latex_documents = [ - (master_doc, 'VCVRack.tex', 'VCV Rack Manual Documentation', - 'VCV', 'manual'), -] - - -epub_title = project -epub_author = author -epub_publisher = author -epub_copyright = copyright -epub_exclude_files = ['search.html'] - - -def setup(app): - app.add_css_file("overrides.css") - app.add_config_value('recommonmark_config', { - 'enable_auto_toc_tree': True, - 'auto_toc_tree_section': "Table of Contents", - 'enable_math': True, - 'enable_inline_math': True, - }, True) - app.add_transform(AutoStructify) diff --git a/favicon.png b/favicon.png deleted file mode 100644 index caf0fa75dd6cf76729ef6c618556a46575830ab1..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 5783 zcmZ{oRa6^Vw6z1};GsB0io0vk7I!Od1sVv!El6-VKyV07AV_g{_tHXx7j2Q^RvZeY zK!MBoAO11!!+ltLj=A=pW4*5Z#lF>11>)1-0{{S^x|)*ylYaiMaIv0Fr+St3C&99p z*OmtW8j}hBg8q5(jJ9g}+5kWRI{*+C2>{$awZirR03SgB;NU#~Ae9XOPm>?$>aS`4$ni)%nN|wfB9cwD0rYJpPD${>e|XUTNsp>RKiQcTQ~p!g`K*R zyrJLHPM&{|(GK!Uzoa@EQ{7ELFuMT@*MbDBN-2+JV&3Xj%hCawpG?@At86v8bDTH+ z;;3pd8m5@B0CJI~XfVy-et~63oKc94naZeu%gPjp&R?;Az~w@$tnBoh22OS6t^G1_ zI|Ieb83A5<2{L3Q40;n}6@ zE0S52OOte@xha!#fdx_135?P5B`FGY)AH@6`-M?7Ra`s7%5)_NvN>iQSWWv$7jXL0 z9xE+-(6s3sQCPVGsgfKIxj^qRQg}=JnD*LWXTDASKvt#NPi^Ikjl|JSelVmAq3H~h&e!*L!KZ?K`mtEK2Gy5gX zC{`QJEKi__I!qs_DdLwL2xgV8)tAm5?!rY;{8cBY7yjhf3WpogZ&qx@i7}=L zHkg^T&faW^d&ZJ4&E@^htZau^GZtn(|9}|Mpm}LxAW@Q%K?pVf(F>yKOyc20UDVN* zpE&egJ-$~v;8$KLa;`2f&+e1?JPVfk!zd9UN=Z85wuEw1 zkbC8PE>%ZlZ}<8Wstkl_@zNxM7EHU9R|3LjkgmgQN2^Y{{(_{P`d$BE4b1+D1@z+b z=s7HB8$G8)Wn%6w8I@b|BuUoTxO8+TGt)okDoG2EHq?*d$TTh5FU(^c@c9j7_9pc>7$O+1SF+rs;#LkXKC-1M@IV}Rh|;`)aNT@(;Phs0 zx_SLe>zXZGXnc>99id*6Nm?y|_H9d5MgAQA^y*~0VUc^r%-MIa8JxZ%;I3AgEf;Z= zVh_$|Mdr7CLyEC#gF8noy=6NU^0NenoFgMeDpJ~a=&7AjaRtUEkQ++BvO6vIF`7(Y zY2<^l2v|Rm#Wo7n%4#EE|MuqBcZ=UGqX8lkW zFL0-!)WpErSN7a(XzYUS5Plv68+PytPYp42(K*|78m@5@ML46a!~*+S1R_=LT8o;W z*>710{7BTP!P{#{E@XxStn4XkHk*bfZcEm>_E#Vn;#CDGXubUy@8!zptx{#UjdYx) z7?*Y^dJijn>5WT4QbV^i>3q&56OMd1u`s(99quF{%_unQ!lCmxx&M^oF+6fY*p!1J zlxe7->fU|ubQ8mJ`I5))4XF!kYS1IqFWT2~2v{7cdvxzjXuTgm@0Mw+BfI|UD`)#b z5C_qpUs4D6{>d9(-j#0YHJA>1q3RDu@L6oAKhxfBmX)x$5WR-Zl^P!S5fy_IiAG@}-(z^-es@AKW@?HUAX2OxK z`h5G_9F73el)>YwQ$_Mev`s`+tj8q?PyL7Nk^1ML)-A5EF@LpS7cbz!6|KwU#^wow z4+nF;g%L|F(T*qVkFevQXYii3<^Gt>=Hz{aG)bCK^zSz^+bZ=Y%V*F5rN%6u{?hz8cON@>nqBIQc|rxBU!$T43p1pgDhlB$<|IYxtjLE; z4)x~Jt#Ufi*{Eu>;S`b3e9g}aP{Yx-KOFazMtg7w!)#G% z+_;d;X0Z3u`C7W$DpPrOzNnEM%>Yb!%i%ssN=@FB=oI&kn`b-bI3Rc1*Gm+4rx(bO zTuBjBixQSo=&i}%DJ?iQHiL%Cu&BDu_nMPxkuu3_#$!KUHp17=Ok7fT$b#*d14m<0 zV=tBw(Up9{pLv0U#@5*XG*=pPU9umy1+rZzs()Mf`371W^g`kIbWCDa6xXOvM<^Y; z4D7Ed0<-`p{Z4wGvLg>HczIEkAgUX&ZtHO{2Fbvra?E4Mv5P{vmuz`Lbzw1Nln~O9Q38X|`T8OshjcO2_c=oIjWLo>Ih0coNmOCgn zW`g6#4qEOTrhbuw!jSZGzgWp}Tg(VGRya`(S8>?&q6)}Qq%`k~=$mMM<|1Ti>hhks zYhR5~P(hYp!CXnC>^c5ONvej7>)c!I+6RM$frjj%(CsUEKwsDt%ys4z6}Mav3cxp9J*eTn`KLalo*(YXnjGq8$V))LeyELy2Ms-c zR~@qQl>)?^co}ijX8;$s?U+`E-m$yHh%P75 z?Xn(NIKMK1jo|sYoQPO@LxC=O&#wgNZma%*9s7k^+Ye#hUB?&Mk&o=+=+j}Lh(j~9 zM}a+BJ4l_szKJJQI2&loC!nbX%CKj=nb`<{aCTm zc7OdLab_MeG1wFTwVyYv=-$O?8dJPPOci3j4<(Uav<$#;{y`_``kZ zJ*eZpAb(hB75^-eFyB~4fqHD#4VHC|0Hw_Tz!&jLFkDqUT1TusTF4ZF96A$l1~VmA zDL2tgFTmgauIc~g|COp)z2-g+s?5yipZ6xV#ifkk6F!EQCK*indZ#91&Yk_36tS^G zeSsbK|JenlI4+(#HeL9<)eGZn73om0u&(!LPrL<;h2+a8H*LASxe9rp9lD}PV=VLR zJ&w5q$>rFEZlsl<6nz*TCe=m6P63o1lC(x~c8>{z#T^hQd_lp)_Wqsg*o_UsGY0Nd z-n*n@dS&-9?4-N^$?{$P#7K ze(=|7^>UWBlQN9g%X8L<#C|cf#+Jf_DKUhMhTY-(k0cfSOAM89MwM_}Bi(~n{aN>o z*cap+`@r2ovdqDKQjp0df3)4&xS^PVQ_Y%W*~GwAXqrV+_wPuPSlm`vQT;)ld4Nl!<+_a(OxD)$VW>$KbB>#4>iR0sc*m~)_v#6( zp6`9L-6K<_9xJoZz~U4~4o<2{_qqG0aO|;Dj0)>HZk=E}jLFoCXDh2waRQ6gtunP0 z?G?>;%Tjl;uM<5(+9SV2y!u2)bc!Xh3?=t5mSc&t($g%pIi~vaT8+x8b*+QGVspxE z^~TT))pECN&Q0z-h4-GlIljI1>XOgbk!K7r%6Dgc#K-hv=1wIb>~M_I*lCp4d|2b| z(EHaJbg=0A$)@Tbg~pKhC=8-d*?qoLofyBAm*%5FSOPnbX1k0rjSjxyoms!oEnaP~wRWFy-*}kS_{=+AmIMc0DYK*G6seboFSw zD|cjuY<#PExac?!Rup)f3Szy(GI`^>BeX;zBQE}uoc6=A=pmB*aS8aAFF|bTo)|IH zh4)vd__WRoRM4tsPYd=UPk*LA>0S#|F@@ zLPCpK6t*;3$XV3%hif;OuNFDE#gw}dP+5#3)!;1W*LMv2p=RQpGj+5!2Rr))u#)|_ zN%^2{fXa{pVb@$bA@7uWHUEg8(i_h=) zTn|3+a^Hw*rMZe$60%2=fK!ynT~%1{e#a&D{Odh*dH9~AeL3`n^%lK$pBsHXQ>M}I zGY317WdDS{Akvs&O%V#Z_24!S#-5MeJx3B*k9gc0DtG8dr$ue=BC8PIU|`*{Dmtyn zdMS7zSj!55+*rZS-_K{!5dxfM&=k#~~beZ+Pm;Ki1sYBwD)CVz&^K2*WlWLZYJx0>?26YpPXn!_yB$(`|Y(Wf_ z{w{wsKDdEHP9He2fBCS_qVblg4u!O~LHS@`bds2&x^0@7;)79Ny=GZuX&%iru_Pzuw)=K_5CP>t>NE8pgDYQ8j6}rIN_gd8%r{ z$FsiJMMH(7WT?SOFtP>`B4n1MVfEGvS*T&QBXQK~V1M@_?i(f6pZztrVYNSG56o0w3RJEJ<5&Ob6&i}9U8=7% z_pdCs%ok`9Z!&1DQ^{`tG5^%5=n}df(0N$;rD&~W*l7NPeqG{u&PXD?Z~A_3v-8eB z*1xa&qWi!3>-G-!{&fy}@0k)tM6}O$_Ima5s?nXf%HPW87^@-gv~#ia6{q2Ta6PS= zdTV{?WgFvnw93n?zTt>;XJc)@#$1KGq28a)A%K9_o6g1Q%2Ler$HfVfC%_F#!0}(z zFoy}I4+%JdULgnfHLa0^)>QrN-L$(UEwrmps4GI7tkk~-?r>QQfc zo5QhhGAC{OFhduX9^4qX9k-xE*+u1^VN=;?x!@^d(=&_ApB7zhXJmI4)vOCY1DS_4 z>t>Vv)V^1Uciu>~PW#iSUWq{vJ&b%hhvI53sdRawbapwR$~ZKBNo1c&yL5UF(53mY zb=Hclzf^m3r-?!)rREi6T)zGRtEInVVvxG;xKpl_;T@4$!`_$*D8kb%dh6T_uBb6= zs~3D$?=tIt;E#yyvZ|Fnk_OymN_3j}O4nY|b7mDB>Q*nJUv@c!`58O7+Y)d*fQ!MPNMJ44FKFDy{jw2WifANut%84e=*i=lXJ}p<+ zm3XxO)HbQor%acr5u5ufO`RhISTAUMhI9C1g{?D3sAfRfksAJ%ZnJ@5)0REF;<;k1 zc_xIftPz~l>}x3|JJ}>s2XP^tm#_+6dM8$%$HV-3t8+=-ypdQV7w*{r9)Gf&4== z(>)j2DZ!utd8Q%n@J%$C)?UE|ofr(}|8-YJxd?e37e7PRe07Da>pOy@!pHY$NT!bI zyx(b;mBvW3fK+-ACXQZDyrv}Y+o1n?CH8aK!tb6LNQ4djjBP8`n|Gh#{mnm=2@bPQ zTFj3bk%5b+9k<>iAt#A%+c^L#=g!)PG&m1^fWOh&2%r=iHA;Jrqx?6cb$gobVKk4ah)mIJKy2J5 zEW&kvP~EpN{9V%e+Y?caSb*AlI)aY4^Q1(ySkN$J6~dsc!#(K8ER{0&Eqh94IE|#u zMb}Cvb;`Ic}Bg$tD<5+1N0$(&Dr*8h($qgekRzO)JR{SRNN98?s?rO}mVla6whX0l)JP5qT^ z^LsmEjicN0#9-OHl})|DAa6S4n|_=JTG1;wR=MWn<8`2@wJ1O>%e zgqZ(Vz||e>2=V{F11cf0`A-4r|0Wo?L%d-is2u`_ is an open-source virtual modular synthesizer. - -Edit this manual at https://github.com/VCVRack/manual. - -.. toctree:: - :maxdepth: 1 - :caption: Rack - - FAQ.md - Installing.md - GettingStarted.md - MenuBar.md - Core.md - Polyphony.md - KeyCommands.md - -.. toctree:: - :maxdepth: 1 - :caption: Plugin Development - - PluginDevelopmentTutorial.md - Panel.md - Manifest.md - VoltageStandards.md - DSP.md - Migrate1.md - PluginLicensing.md - -.. toctree:: - :maxdepth: 1 - :caption: Rack Development - - Building.md - Version.md - -.. toctree:: - :maxdepth: 1 - :caption: Appendix - - Issues.md - Communities.md - About.md - - -.. - This somehow triggers Mathjax to be loaded on all Markdown pages. -.. math:: - diff --git a/toc.md b/toc.md new file mode 100644 index 0000000..84bb9bc --- /dev/null +++ b/toc.md @@ -0,0 +1,27 @@ + +- Rack + - [FAQ](/FAQ) + - [Installing](/Installing) + - [Getting Started](/GettingStarted) + - [Menu Bar](/MenuBar) + - [Core](/Core) + - [Polyphony](/Polyphony) + - [Key Commands](/KeyCommands) + +- Plugin Development + - [Plugin Development Tutorial](/PluginDevelopmentTutorial) + - [Panel](/Panel) + - [Manifest](/Manifest) + - [Voltage Standards](/VoltageStandards) + - [DSP](/DSP) + - [Migrate v1](/Migrate1) + - [Plugin Licensing](/PluginLicensing) + +- Rack Development + - [Building](/Building) + - [Version](/Version) + +- Appendix + - [Issues](/Issues) + - [Communities](/Communities) + - [About](/About)