From patchwork Thu Dec 8 12:55:20 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 704059 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from mail.linuxfoundation.org (mail.linuxfoundation.org [140.211.169.12]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3tZFkm0HCbz9t3N for ; Thu, 8 Dec 2016 23:57:20 +1100 (AEDT) Authentication-Results: ozlabs.org; dkim=fail reason="key not found in DNS" (0-bit key; unprotected) header.d=that.guru header.i=@that.guru header.b="udYsj2vt"; dkim-atps=neutral Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 78F6FBC1; Thu, 8 Dec 2016 12:55:51 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@mail.linuxfoundation.org Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id 44306B8F for ; Thu, 8 Dec 2016 12:55:50 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.7.6 Received: from brown.birch.relay.mailchannels.net (brown.birch.relay.mailchannels.net [23.83.209.23]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id 81790163 for ; Thu, 8 Dec 2016 12:55:47 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from relay.mailchannels.net (localhost [127.0.0.1]) by relay.mailchannels.net (Postfix) with ESMTP id 6DA7E224F4 for ; Thu, 8 Dec 2016 12:55:41 +0000 (UTC) Received: from one.mxroute.com (ip-10-229-10-199.us-west-2.compute.internal [10.229.10.199]) by relay.mailchannels.net (Postfix) with ESMTPA id 9090222D6B for ; Thu, 8 Dec 2016 12:55:40 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from one.mxroute.com ([UNAVAILABLE]. [10.25.23.62]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384) by 0.0.0.0:2500 (trex/5.7.8); Thu, 08 Dec 2016 12:55:41 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: mxroute|x-authuser|stephen@that.guru X-MailChannels-Auth-Id: mxroute X-MC-Loop-Signature: 1481201740999:3133994842 X-MC-Ingress-Time: 1481201740999 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=that.guru; s=default; h=References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From: Sender:Reply-To:MIME-Version:Content-Type:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=Z268EW/cSGdinYTF/iEI0zcvhFQOKlpny5arxGVpuK8=; b=udYsj2vtwRd56hyKeUF+ThvVJO NzOKuiohIFIrwF9RRbJb66aaJR9fITMfiI77+kDVWlVVVphWNo0nrGPT1aEbWujjh2CKpeOzeKa+P bbzlBKkGIrTD59RT0a0vf7lKp4rHRvW6fX8Q/21Gq+o5oIt0udbrBOx7Az9VixbUNL74umDlUf5+B sEnkY/G97aCfs8B5Pat9XkRbhYx/tzY4WtssblrhjR96xsvRsOKDRFMz+zZbbgo3yK7JEihb8FClr V/w75YAjkfQTLAtHXwPQJ1ntdI1nFwGpT24nqPrJ9NmzSiePYKKQcg6USWeS84OKgg3QK9/Bx+ZjR bUNaMz9Q==; From: Stephen Finucane To: dev@openvswitch.org Date: Thu, 8 Dec 2016 12:55:20 +0000 Message-Id: <20161208125530.17283-2-stephen@that.guru> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20161208125530.17283-1-stephen@that.guru> References: <20161208125530.17283-1-stephen@that.guru> X-AuthUser: stephen@that.guru X-Spam-Status: No, score=-1.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_NONE,T_DKIM_INVALID autolearn=no version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on smtp1.linux-foundation.org Subject: [ovs-dev] [PATCH v2 01/11] Add initial sphinx configuration X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: ovs-dev-bounces@openvswitch.org Errors-To: ovs-dev-bounces@openvswitch.org This is essentially the output of 'sphinx-quickstart' but with the following changes: - Parts of the generated Makefile are merged into the existing Documentation/automake.mk Makefile - A license is added to the index.rst file - The OVS logo is added - A 'contents' page is added, so we don't need to include a TOC on the home page - The theme is switched to 'bizstyle', which makes better use of horizontal real estate than the default 'alabaster' theme Copyright is assigned to "The Open vSwitch Development Community". Signed-off-by: Stephen Finucane --- The dirhtml buildsystem should be used if the output of this is used as-is for openvswitch.org. It's basically unusable for offline development, however. --- .gitignore | 1 + Documentation/_static/logo.png | Bin 0 -> 13341 bytes Documentation/automake.mk | 23 +++ Documentation/conf.py | 338 +++++++++++++++++++++++++++++++++++++++++ Documentation/contents.rst | 31 ++++ Documentation/index.rst | 28 ++++ 6 files changed, 421 insertions(+) create mode 100644 Documentation/_static/logo.png create mode 100644 Documentation/conf.py create mode 100644 Documentation/contents.rst create mode 100644 Documentation/index.rst diff --git a/.gitignore b/.gitignore index dadd4ad..f61f772 100644 --- a/.gitignore +++ b/.gitignore @@ -72,3 +72,4 @@ testsuite.tmp.orig /rpm/ /openvswitch*.tar.gz /tests/lcov/ +/Documentation/_build diff --git a/Documentation/_static/logo.png b/Documentation/_static/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..11d7fdc561f47d404792f2529c53521567139c16 GIT binary patch literal 13341 zcmZWwWmFs877bFMI7NzUad!_6#ezfe;_k)0xK?l|1d6-66{om61lQv3Z@%9z$z;}= zl{ItkJ+}8gH&Ln(ISf={R1gS+A^%ZY9XO{0hdBxo@Eu^q7yz7*Ocmv%L9hS4v)c<3 zfGcmEKkB-HKxnxC9dMxZUxdI#w=Kp;wxytIU-*V3_}r%3WD z$!pd?$bgZ>r7B~hq-DF+rdj-oZI6cS+k*!C#i>7kgeVmlot9>b-<9f=tDli_N-_xw-jf(TRvH-=UjKmI zy9}qW_WTocV*+bBCN|!lrLY@&5a8fcD=I1FN#1n7V<{CCEKrrrG~H1Q6_pVb>|dj(sF+|zh!lzq@%B_@VrOTc znVIoh$&*ir%iwbYzXg@*RQ6vTOurh6yM1vcym`1jdI|lG85R~c)YsQX85*RHiWzZP zI*F{n2ol%UCNN;Tjr!I0bRFRTcyf^;bghfpQZxHbec^!xDfQvGt9+1}XY>&I*hD=R5AH5|}7w`HuQsp)29US3{bb8~YiqNaPK z38Aw9skM!bjQsH6T?-Zo0q0C#{zy*`!sG4fYbSDQOoB$j)$OSYZSO#aCQ`}anXa+% ztIg%^=%dqG&CV!sV4zYa-!YVS(&zTj{h%-Ay&+@%%0pQMHaz*al-Y7$&qn18KErfD zH#+SKgZn__3YU(Kg*FQ`pWBmm(VP2AHFv{~u&};RTzVBpy-r6mI^`^b^0r?>&l4_N zAdvs#RoeX2MAi0Ut(E8zi8(%XXHn6|0|V!?zJ`K=MhP25P%5w8+$+Xle=K=ilHJ@# zz0?fjO04g2;^yYtvde6S4a(^v%}Z_NxKRyudk`;g-yX9Cj->bOMh5bVirnvTaPF5= z+1S`H0i!_?kg*&e#cHT!SXf!8xw*Jv11zvJN31~2Lm0$ z%DBzTrOzo%=-B5L33PS1=(d!`ZB_A zmOuiXySOMezCp5`6P`d47NXwXl=)I!o%XQV7c(oFb4D@$mYSM+@bBLZm2{4c=dv_z z_ZK@#{i@G!Um?(B->b8Y80M)3x^MMD-evxX@7| zG)}}GM=lRlNzAqa0-w$YnuU;;u56~OmS7Y&9v)j+Vu2mSbd;rc3`9g}=<@P^mp3;z zvF`i=Yy$#bn1R>e&=4?(_a7mUFsv5w-*BL&boxf#EcW;Iuq1U!BD8@&gR&;It$vkX z;pk~XedDK?AX2a&VMRqn*+nZRS<445E?0Y9-855o2?%4@&!1D55#Pv(?v>NJ%M2S& zj4>LnkLIp1QBY7!gwHHfF?@_wK*N z*h8-C-O-HwnPObf`c%H+CVz$TsmIAm^Om=_xB4vpt@hlUVm!I1&?}5>*5~@r{ox*P z(2}3vMD>q~ihG_%bIN8t{c+9J)zusv9CuW!C0eB%X8q`(AcqvT`OU4ZR=;t51x8|C z+r;HstMRpAow6okNz;wzAE=3Gw{55UiFf8?4T> zRBSdd%E-u=TSBvnLRD2?Uk^A?>`I;YWha5P!*avu-S@O&gIRH0eEhy5wcK>&46tYi z@pC_??JN^BU>!_QPNJl``p=T0B9@MTt^V%AhI&15Hy00&7XQba>cjnysHmvy6k^`L zjVWTmU-q$AR#rFyRs_Z`_r^~vFc-GBw@q_@=VH8;Q^t5dXtp`QI*Jq3^Gl{mN=m>j z6y$3SE$#wBLN~tHMEA%MJrY~}aWp3p5uUW6+Z3Wcct8f2Wr|7iHM=ZO1_kX^SC=k+ zja82(VATr+`#d#S_;W6gj$$}gR4f29%DOpT)^}o~|xYgq-xJcaj%ynk43B!F-NSUUv@K& zrZ4w3nXe^U*N2~lzuYDGU#8_xJV=K4%`6zZ2l&Nb55&QjnsMkgBTj5}FRSVsNg9G(7BctcG_Vy4~7FIaWGCYF3v~;K)5WsjD zT}*UrFV43ot2p)dbnmUKjM-9{KXVF10?#TBs<(qOGBJ_ER|Umw2c#rhPLEBw!mzFO z&RacC$4HL0Ldt`KJDomjzO89=BJn(&IS|b#j#Q5hcz&>nCFZ6ZEz&CWvAa4HOLl5| zzS#9r6_+ni3(qPsnqCYc!1LP+*L?try`cS4SwRK4>+6gEV`X6N!HOUQ7#u)Jg4GPv zadI*5ZvVTpoQaWgwty zrlx92!^8VC`xKK=K>{pNy)$1HrANC7IGmh}hVc%x{ zJ+UOoIZ@C$bk;25fyP7y&_LE}ZTAW;F6Y#I7Jd(R)uXqahMg`wQhIvCq?m<6^z`(| zH#aw;C1^FnDQs|{si`TtsK`i7T`VfZa{b0N;HTle6BDY~k{5}@ye;~fLYJ49GLlkK zl~4f}>T0WR426voY6;PM#3d!+_4M@iP^dCq+FWT9 zvAdNB#mGs-TI&KxCSvvKeNs|V3iY&vfTe46JUQ_JkP&WG@q+K;*^g50w$td?zn zn;9mv8wa!t8Jjs+BqgV(muPE|5QPUfG;2%|fp}UTo24rjlG$MFuZr*4*|2VEV;#+vAL%c)vhnfxdx;o%I5gPdNUG}TMORf--9NDE;WhH| zV#LSBYJPEb?FKA#h-IBA?AZ^@T?ii!uZroTipr_^>d;iW21LSx9hzz62@;1u*jg0m zoCUltcjF)yrx2(R@7IB?>cgV8HW5V|qBL3irKT?j>P*b^@5LD{c=!H`UEap3!Pv;V z$)-#J8}-Q!1Y|vC1_r!24<||>>$|vAdueNH8^5>OD+304L?P-|gq{e+D1L9Yz8go9 zxfmY~M7U01lI1ML@b@b!q73%(z3eP`HHCAd?AwYPC@oiMaamDOq&*t?Q&%w&8QHU% zgv16?1||zD>yG_OlZ%R<_o z9$I$`>$iyTZQhrbn?p&=+|v+GWwjpY?I zq$<=$W@g~wBG)Id8JI$0D;!14*iuQOj3 z6cp4Cpmq$)R*^pK*EX;7&HQ*WAw)8;Yu-t4aza9nE%D&k7z8fpWVQ8`XEd}Oy!Cqx zjLD3j%mfOmYx+_U8*1NF7W(h`P=xDUjpq*S&UD}%cDG4-=>a>+)e^7U<81keZR3Ui zKc=CfKKoP%ql~0vH`dcaRe&g+QtFwkuI|0SGQ|68|3_&|4B8qH#nWGOb#*cAk*bS| z7{Ubvy=#sqjM{zo!i-wyU`tC&`UVCf#xjN4!2wTAn(miwrDx4mOwzKl z1yihK!{aRd|AH?$9dGxm8c$&hexvgnd`5eU!wMy2(_IGR7co5z-R)iY8^7xts%O7; zDN=(zD|x~y^IiFd-Bsdqa&lJctEx_~p{N#qf*|^21gEz_`9flXm;0Rd3v*Rf97KF1 z1VAp?^7Hq{)#q_~u|T%h;&C|CEW5ddU2mUni2_)~7>9&JICGRqK1p3(8Zjy=YP7+A zjTB3~ek`bej-RGX+H^#i5BH|v8PAMQ+E{T+!B%5!F;E%b;Y+NY*boDPH)EIxx8Wrp z?(y@QX0oi2kx@yvW~D+Aj%0vPiXj?W%!#R4!uRjrC-O>aTwPr!a(!=U1C5$5MyCv2 zUAg!iR~US6Mu=4S+JJ$E0r?oS(^kh~yVDZmX}$~&g!Cu28VoLlwRv-k@bbF5Lm-%i z4H2!d4*yb98xt2!5$fN!Q?!a4o@;GOaLQ_GKY9lSbQa|$gV$rQHk5i9(d(S0i?fvi zXBYD~?rHC9@P9_YV{=JX&vp$HqlLo%Jq*YWEizx*22a;8quPC#W^g@S=pjH>yDu&P z@|77t)lFGaJoW)p6mVdlCE#M}Bqr9GqD98K?JV$7UY^Lt$%-G=+Zzhdy0Y%#m|z5? zD?Aj$O%~SCiG%4vIRJx@<;s1l;N%z?8Le$VLP7$e5dPa2xCfY;5deR}Ei5c}g$(;Q zoX=jKAB_M4;J-VT@&1!tRI;(^St_>a@b3h3&^i#0`;L=jrLUjnZcj>uB@)$7=GT1T zzbN!w&1mDawpni`0hAFB zw|T@?R0f^a|bxopM zn=f@LT9l>ltN}jXJgl8~vd~d`R2P!aSYS@8^1JRt=}1A&`h8_1NYzAFTNa-R;46y4 zHE>}-p7&W^+<9TjghD9*dxjU6l!Vv*_`bNfsP6yoxD^f{ryz1spY2guu}x-7Lp!L^~`8W3u50Zl%aopV8NsDuC@iLhNE$sGr5GS!(O!nI7D6t$fDN&zzRz zWCGJxf6OaQotaOOfgnLl;=06Rp2E>RsHOhNL3Xy?(9qDmJ(8xWsp$Y9z>til3tnPp zG;p9J`1(Hn74^NrL%%({D}N#epeO)VbCEEJ&4>CW3@2~djXUZ}c_*5vsjKaoSeThL zIQY3w5kbpsp6s@x{5Lz!0%ECF?@ZtIiKrQ|s3hLjq>nRms<~*(hQ1!oerj^2;-{nQ zkB|G!Oh*?ERFE11icst&K&X1LAF?DwT5fP?{gs(nKG4sgrlsZIu>=#do`qpob2;mK z3pDRAYm1yLmg+b)$ZASRNYpY-KOgRdV~{v=e&{{DzudE1;Lw5?fyJ1Z6f6(Bi#Nwh{!FZ_7JUo|Qc?qo zDQx~};Ww~_T%XJP>j417X$pq^iFA7MDxOxDejv}J>+dHL6cil#55^Y|d=V2_$V8_s@?MZ0O`5F9HJL+)r0(ftZiI@qb~2Yfqp69BnnSto_*%OF;QU~G{G_rLYhfxx zOiWCgPjx9uP(Ed_^Kyfwl%YY(^77(wRYQ%>yrxbg!*+Mr_t4PLJ|JM9f!bMAP*n7( z6z9+0rE!fsJsq941rL>WmJn*ynrc>3Qogx^#kEds9Q~gegoG;3ep}W?Yh>~CNCis$<580e8s@Dv93v%gTD#% zFfreoe|@X1p09p4|I$45^wOCw1v^&eVXW-z#-)5aySo9VxrNnH*ndj+Ek}P5{oOiO zSd1UJy1Fuw%FOIcZLrx@)a8E}H&WXw;1@fKDt8%C7%0*|WK6I(HAK1N}2~ zV|jTW?jWhyER2l0rPFut!JxUhxg)F5bSVJCGBi|F*CRx0kDD8r@bGZ3J;@*kx+AQ))^nlCL=^6G_uYA_^&T?l>`-Xe!!V@m zTe~O(`OT!GVe8u8(a~9p)_{Q>*O*vkWjjCS$c6?!A@_Y%b4$xzjf|Vp;$r_507I9^ zLp`IPq6;9<0O;|pMP4CRahQqZ&xD_!48y4aw=KiXh7+Giidq|7}3A zqBtK|zbDY==ZEV~CEtGwocm|@m5WMIq?pK@oSdQnYV9puE&y_kxQ?70z%LVLv++^F zqTG?{0JYi7gpfTztS07#Mi>_&EP|0$`=@85kM0 zgrNW=_y%~SuKUFxGsB8yJwm9-;B=vilOwDl4jB}zA4q0tzPo4r4GaeFdY-J9xMwA) zqjtoPiG$BA}%MuAFBP1pL)z{z5iic`qZ{K#ma(}sH zr*0f^bBwF5uKr~a(^XzxehFxBco(Wb*9H^550-w2`?v?mq{}ZXtOQg+lXj{a-CE1m z%J6WXS+ohTzK=#0*q>N6Z6=aV^dw;c4}~NS1XpTu8O&Z#alQ$An5cu$47V= znON#Z05wF7^r;ef4CD1iu3S2eZ0w)4cHg5uj)T?G`NO?&s7h%`<`fqf4;@`WzZ}-{ z(-X@$;+xgV_^}ZVbfDjnT~QGrr=@)SGrR2Ho0MU#m$MBiXkudG8lc$EZn9H_5+5EN z-PSY)@&-KJwIJ(hYT_-`*&ulGHxltXtr_U*cpCVNVa)BU>T+>$$s`misa;=PjmU^< zxQVuxO--ryF&WTIJFT_sP~hO4PuHf4<)Xc3`!hBcpPG?IYh`I^I}@s6eAz;GPZTZz z_((UjbaT5T>rAKw z+9pPT%V3s_kzv%whj8{6`d#mwZS<&Q_4j@R$cn)JX&YX$3E|m?58!(HMc3Y>QXPM% zl_oV*5Wr8L9UMNjn7;+A%jd^#K^Pv~((W8~z=NEnzsf1ptc%`_<@*hK3^mTGGuTk2B`)PvsBy`aj+} zk?x+vBOqgGGY4kM-7GdZkPxsKc#Xnf#^vQ{X&EKy#D`q#A1%=DNTJ7g&~YaMV&bI` z?2E<_bkOct=FtZln#+3MJ}5SI5k&eUU!BE~w$d*SxSaV4Wyhtu;-tE|FPY~C40u2) zqxnxW8ofP+b)EzBokh}Zm#9`xT2TQ0 z(v}XNqLL5){oBXuG-)~v$lP=DJ`ML|BVhkSJW^6JI8cRDgby7({kXi6(#*QEfB}eF zE9zlf$rObuwk{SOZ+izTo=n&yETQ(&4ip(18`|6~_!3p;K1`6C#H=IBZ#VaEp}vYE z1!mZpQF^qpzrUXbMCc|!!N$D|yUfB(5CNZYiI0y51bhk#Z7bVR*eo2-w@qGbwfc4l zRMPEw9^Q;jMU{C?RaFlE*B4P5Y!pgb+BX0e0))~U23ZEbm-DRwO6AgTi_e6bo0 z6CO&|(BHqJk9X&0Pn5_Jo&XtN1XY=zn~r3>R(3kn{K^vX{`$)09Zx6$q7)N*b-LwT zYxTs!m=S*!_?`F_H7wM`x*Yj!V{j(M6*n<=)BMa?(=9pT3cP|1J>PO{K#VVqAZ>Y$ zCwMyJZXWjZ%6AVN$k^-_$^2JVrVSua2i4(eyIJ_9Y5l#9NKF-fde_5V&L3xwp2En; z(4*utI<<1A&KL8iEAQ9F^@q!k_n33J%Q_N`#pFi)U^}35bWdIh`!IA5Iimq_xSOn= zG`0ogwY5e1dVYUmBXI=jYCzYlkBhhd(?dR+cN**VkE3(!X3nUYy#1pjAhGBEU_zMj!oKf_~x>S*j=k}xscpGAGO z*Y}jdH5SD+VK#PpYl2HN6IB-S8FR9N4?aHsO~n1n7wd0bM!2;{UQtERa(80rc%fc; z`j_X)h-0|*yKpDk`_B}YsDJSBr3%UYb=v*zC8x42 z6c@G2_4wlb&m~Q}M&8o-wCF`8!ZW_Dp6ilpDBwse!P;NgeTBESlB%%xfnL8&*Iw}Z)t7CHc zlQB*%o^;XsiqJTrJVWRCl1N~!rz_(>oAB^jx5ls1=$xQy7kQ=pRO?s`yiM-(=<~un zI9k!vNdeZUSYnt@UR20)CpNwQL=20En+BnzXKxyF^#NI%E8jH&ot(?!siFAtIYxCG3|?*0LK6kabH6;G;a$WqB%Mc@#)yo~TY{$jUo3KUdI>jQPBgJnO$aB$b(k_2_RKIxcQU z-@ykxJgAR;Y7M>t@`-LI^GabQEK~mzd^p$s0oT}DkYn55dy5=5I`o0mw3jZ{3>%7E zyvSzUO>S>xj@M3f9?3!djus{qDh3t?SA-xFGphh^F+U~m!5?75g<>2Eu9z2%r($(E zMTOVT5-4Fmv`!Tj`!OOBg2q}0b~ZhG7E*U+$qj;LQ4?-B;MO~FuFZ&b|x-Hf!CfRTAGyHJY22?zwFk4 zK>|&2RK_YA(4&cxJBO7b91q6|M>kR=Ecfih=$h}ULy77b3dQ~GQw;u)Tnv!j;ZO!c z{zsqdJZMzf?2ZSS5Q%o)s`tOATklzLW3_r^tNjTEEB)=;@^7%`xmOR@Edy1BeDHj! z_w%=0YUuDZz_F192!+`qIL79Nf?J2jKHq^GB;BbTy-;k@R|$^;pito74>UU6~U z5sG;H&RNhetEs4Xr0Ca0(LYe+^`lAi;acM|34Dv%P+NiHCm zoten?b8uK%YGS?4YRbN?ToTPwDP+}K@>`PDi4clQpKW=!_NRBSN;P7<@VFH#7A`0c zS>m1cF5S4hm_7^`N}Wc^$v0$lmt*pzzaQcLbWH4lf^K#TH09(X^gL=xzv#K`&z&SD zIY6E8mVK>;qym@pGQy7b_b0UbcN5i_TC5g7r~m`AwY9n2QT32Bd)^ZA1DAV!asN_; z*(sQxSOOmul8FJU@J%6PRaP#^FP7)!Mx)I(u|j?amBVkMY`C!- zp|(~`LP?2K`6^v>PE|u0At*8Q({e;(w<+A`so!LvQ1pBd4o+9rAFZQz8dHKpOhe;! zyu4slg&!H0a6cN^-yr8NT_!+Zxuxf2Vx#9FfDuTUc~pbCZjd)`Xzya#Urm8 zIW5gB%k4aOyIR>ToPHhT<2~=T8@>#bRf9M@HSV>Fv=Ih^=wLQ!S8UVpc>6o+oWHQu zWf?UT7!igh*pWjRtq*PyLKr)#<(<8@-W?TIYP`$pRIvWLfz80cBq3!;hAyS1t{HT< zkOGr;k$qZ$&Npy}qRGhgIq%3uQ<7q?(e^VMhz4GLEDye6JLhFULHt^?`Sq*8;my3# zpY+5$Z+H+k?v_8UPfbytG$6gaTkaS;K3!|>Yo;JK!F!}u?{2fGWhIq7+gM!&gKM=_ zQbl@^T2o^A+x+Nl1$#JDRi_0>-rwq7$S$}~`{Mi{es*9flaUeVJ77F#8e5ybtuW>| zWd81^+8_CWWz9$ZdZQJz@%yQL)^bVaA zhKE$u6WIw|{pLrz$hWKz{$wRkaq}kO16ES%t^a{AI`iE~^TgOU;ikV=I)PqI z?U)=KMMuYaX9uF>=IyZC(9!US3$nE0FG^JeRYVqr9u1!J)(E){hdzMLz%<7h&*Ibu zY69^Ys{w)Q>FnpvPGrJ*eoP;}{QCK8Mt=y!g=Tx(Poa1)O6(MijfpX&DG#1}wR1xp z<^DILlaSYgQ6;9sjk+_o3#-?eTX?{^8mA=Hm7e}dwBH#+?k2ye#Ttg1nj;sL_)zJ- zLS;PNN`JPu6K7rHy`x$M%1|^~mH*s2EB>h*WWfrWpaXPkoA&oO%?=l+3_H9&`(m-` zJoMr5TteO$FL*!Sw9|EvW9EMF+N4dy+5Fqij3!cuG>9#UNFb|B2PY1(EP0==DXI0_ zz%V8%urWj(i4+G%q{+i_v%}8C0F=rT8=-*f^8%#(_NW;c+9R)jw!8V-ksHmx} z^Ku%Umk%x+WR<#vQ%MfV;Xx+yaCGCa*$!=S4Nj6PafmFc%$sJfrw<-p%0V}Df<43_ zO`f{WW`9U%k3aj69bW6xAEzY(q*!kUJ2b4u^y?QOpG)=zobFt&Idf7>Tg=ipV@wic!4bW zRy(7v`%yx_23+a{5N@dk;A6=tU=YleD-tS5M51I3fJ^)-!D?)KL{x}am6>{&pdZE1 z1!12EjMOtWdJ1%!PzIHoO`QjXUfLZ6f^R2`siOY|dd6}y?b(7&K;1ZYs|LDHQkDe_ zAoGGkXP|dlh)qt;_Bwib_9KxY1&aVqD`T{M?S==oEO6B}sVzQso%ArdtVVVzAL)DGbl=Oqmf}xHda%hn zHarZxk)*nCiy&zUW9_IelgS?L+^?7OlyOppok`* zmY?KA+j)N$MnH=g8Z;z-N$8S=n4kE2d}7k-UBb`w4|KFd0k0q0ymKjTAL?Izlrz73 zDJdkium6yf9NkTUp6^BI5wN%sgA*e_DlSpKn6dtxK@Ivd>qgoZ(F!@4=`idabg8XC zsxZ7#hD(MROUAuL3HmvuP6aAU-www>9#_^*PGMwVW&3`aS?enO@c55SM85cE;$7GTs$^6cXLI4H-g;G2M_J^#%Mj-E}{qyg6=1{W@iumCbN_mh8Qw zz4^m`2mCweK0$BQ`(i0v6^T_zSk&N%Qp0pX`q(c`JTmdlx*D#+NTajTEj9OfgUt8F zh>wrAv)z0eC#=O>^&-KIGSts@QPU1hHDJj=TVBwk&pe{eFfbX$<^8;_@Wr+?@FS)9 z*@6E%A@|c)Wr5JJ49uRfxkJcJp=1T2$~zxf0vKX{v)9o&wYLpx4K^h1+3A)B>Jrtxt~s(3XEYV${WD(z6U1-Pz?? zKZwt6H8_!bnV^(;NPZ6$(ZVYQ?{sVD^W$29;;nE9vhe81YH8uo1Xa9T8S4`2xIu>t zmvEza$}oOdveB?IKl>}E?OCdg^Xb%~ue?OU*6+uLdi&SG9y_I041JFSpJrj!MfZQ* z8o}Q;6#g=%g#B8XCIQV+pn&aWq@M-lLSu?r=bs{)ytDS_1A~GKA62I%ZdRREV`GW* zDq4&1M@YnY3fYMAELPsLSCWMWCtvvBK$pAP;8(Sge`=lUx) z=2|Z})pl}B$gL`27(JycWLGaOEx?B$#ddT9dyscdq~8APR)mvx4s<@Zc2NjqT~^_1 zRTHvUnk~1(3_r|A5x`2%n8k>P@_8j^eo^BQAsXR*T-o`py$Cj``J(zQ(njRE*464? zL*GTKSTeD{zC9216>K37nV8MDn-E!#9Cbs4xY@MeQN_aF-d1~_n3=4^jn*aY_iMRU zYqWhbUKwXY4-W8Uo!Y2^h}L<(*?2hWYXqNyXe2k1b^n zMKL2nO8L1Z7!eqC-&_%{FaE%$7V&2%$JADyTpgJxlm2Mj3Gpe!abf;a6&X4BS%C;8 z44qImlE7ieI+OQ-DC*%YJb1yYin|Z338G0@f1nVc##+; zQiWdQ<@ZeSKVO(wnWtG;n8MrI{1^p(e)WX1)NmJNl}-jy%wAc{}h1hwm!+WLI^ z{ZrkcqDY`;CtB3j%*5Azpdi1|GmCAWB%_f}k=&!hCKs5 zM~SPR?c^*`(!i|}>89XoxbEHPkQqW_jmzIR6C>`<#@}YHe!(pYQfTGpSxBSkT$#|+ z??!~EoV18~2Sg}b`iy=`;j;{V3}*Cgc#|o1qca#9Vpq^T>NNWDSL4Y`4U0*Pjh>Cx z4c0wnnv@og1 z*MsSo&{Zxbe$(DOGcWx&=>6^~|F8)?WL{BNYW&THm?8`T1LG=C;ujJDk1E0haS@y~ zASk+@tQBdPy9qc+%g8{Zon@w8#<24+t|$s*G~{?Wa)ODA{`fk; v documentation" by default. +# +# html_title = u'Open vSwitch v2.6.0' + +# A shorter title for the navigation bar. Default is the same as html_title. +# +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# +html_logo = '_static/logo.png' + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# +# html_extra_path = [] + +# If not None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +# +# html_last_updated_fmt = None + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# +# html_additional_pages = {} + +# If false, no module index is generated. +# +# html_domain_indices = True + +# If false, no index is generated. +# +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' +# +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +# +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'OpenvSwitchdoc' + +# -- Options for LaTeX output --------------------------------------------- + +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', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'OpenvSwitch.tex', u'Open vSwitch Documentation', + u'Open vSwitch Developers', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# +# latex_use_parts = False + +# If true, show page references after internal links. +# +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# +# latex_appendices = [] + +# It false, will not define \strong, \code, itleref, \crossref ... but only +# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added +# packages. +# +# latex_keep_old_macro_names = True + +# If false, no module index is generated. +# +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'openvswitch', u'Open vSwitch Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +# +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'OpenvSwitch', u'Open vSwitch Documentation', + author, 'OpenvSwitch', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# +# texinfo_appendices = [] + +# If false, no module index is generated. +# +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# +# texinfo_no_detailmenu = False diff --git a/Documentation/contents.rst b/Documentation/contents.rst new file mode 100644 index 0000000..3ecb741 --- /dev/null +++ b/Documentation/contents.rst @@ -0,0 +1,31 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + + Convention for heading levels in Open vSwitch documentation: + + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + + Avoid deeper levels because they do not render well. + +=================================== +Open vSwitch Documentation Contents +=================================== + +.. toctree:: + :maxdepth: 3 + + index diff --git a/Documentation/index.rst b/Documentation/index.rst new file mode 100644 index 0000000..5e9c63d --- /dev/null +++ b/Documentation/index.rst @@ -0,0 +1,28 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + + Convention for heading levels in Open vSwitch documentation: + + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + + Avoid deeper levels because they do not render well. + +========================== +Open vSwitch Documentation +========================== + +**TODO**