[ovs-dev] [PATCH v2 01/11] Add initial sphinx configuration

Stephen Finucane stephen at that.guru
Thu Dec 8 12:55:20 UTC 2016


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 <stephen at that.guru>
---
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 at Eu^q7yz7*Ocmv%L9hS4v)c<3
zfGcmEKkB-HKxnxC9dMxZUxdI#<S+8dGRSLaMDJNi6U>w=Kp;wxytIU-*V3_}r%3WD
z$!pd?$bgZ>r7B~hq-<TDa)#u`D21gZUv`_6n>DF+rdj<dwz`it*&`nrd_~6n0|Gxf
zNi~<RoxAyiZwCh4pzg+dz7=kU^MZRq;t0H||M!^)jQ;uaXTV*Y`p|N-T}tRcmC01A
z$FVxOz~>-oZI6cS+k*!C#i>7kgeVmlot9>b-<9f=tDli_N-_xw-jf(TRvH-=UjKmI
zy9}qW_WTocV*+bBCN|!lrLY@&5a8fcD=I1FN#<aOVs~#iN2)TIgTxgSqSdsuAyX3*
zD2<M=m!QhZ(|V-Ts>1n7V<{CCEKrrrG~H1Q6_pVb>|dj(sF+|zh!lzq@%B_ at VrOTc
znVIoh$&*ir%iwbYzXg@*RQ6vTOurh6yM1vcym`1jdI|lG85R~c)YsQX85*RHiWzZP
zI*F{n2ol%UCNN;Tjr!I0bRFRTcyf^;bghf<D*%!}uUymVeOaJmVq&uQ`!{tMD)^mb
zz>pQZxHbec^!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*Jv<sEhv2tr!CFLxCy4BCan&X4ua+`j~z&Irzq
zS1to%3V8z`+$$D#-_p{;X)<3)a({nMMM=3X_O`07j;E-&*hNWM>11zvJN31~2Lm0$
z%DBzTrOzo%=-B5L33PS1=(d!`ZB_A<AdUobad9b+U9R)CvvPvnbu#^(nVsD at JUqM>
zmOuiXySOMezCp5`6P`d47NXwXl=)I!o%XQV7c(oFb4D@$mYSM+ at bBLZm2{4c=dv_z
z_ZK@#{i at G!Um?(B->b8Y8<?S|y!>0M)3x^MMD-ev<E4j8p;pf$K2bI{N3AfY0=~<D
zF!nf;RQ6=^uy4m!0no$miHUftoq?T3;^N{@lV$@i+ at EVX_^}2D2UFDzUo_8>xX at 7|
zG)}}GM=lRlNzAqa0-w$YnuU;;u56~OmS7Y&9v)j+Vu2mSbd;rc3`9g}=<@P^mp3;z
zvF`i=Yy$#bn1R>e&=4?(_a7mU<ol}w+|KN(Dq4$F2;iFzmlqeRxKbhNsBhm!-7UOl
z*Ta=WeLV*0H=Dk(97}(LYqs_E*Dq4}277FLd|K4#=y_V&4-j6PsSo`l-M<C+=)&n}
z>Fsv5w-*BL&boxf#EcW;Iuq1U!BD8@<s9px&kyU|w)Xo*$5kJFO-;>&gR&;It$vkX
z;pk~XedDK?AX2a&VMRqn*+nZRS<445E?0Y9-855o2?%4@&!1D55#Pv(?v>NJ%M2S&
zj4>LnkLIp1QBY7!gwH<E(xM&z`zKWS7RBrAxs^HaCF(@f2LxKu)eA2yEYyE`ClIQt
zr8T=R_Hvh-Sy*WG_a5!Nbtas{VvWT|h`d^p$F;43jZLw+`vn&|0xoU>HfF?@_wK*N
z*h8-C-O-HwnPObf`c%H+CVz$TsmIAm^Om=_xB4vpt at hlUVm!I1&?}5>*5~@r{ox*P
z(2}3vMD>q~ihG_%bIN8t{c+9J)zusv9CuW!C0eB%X8q`(AcqvT`OU4ZR=;t51x8|C
z+r;HstMRpAow6o<r+~VX)t1b_=ZAWK_q at ojUnL6w>kNz;wzAE=3Gw{55UiFf8?4T>
zRBSdd%E-u=TSBvnLRD2?Uk^A?>`I;YWha5P!*avu-S at O&gIRH0eEhy5wcK>&46tYi
z at pC_??JN^BU>!_QPNJl``p=T0B9 at MTt^V%AhI&15Hy00&7XQba>cjnysHmvy6k^`L
zjVWTmU-q$AR#rFyRs_Z`_r^~vFc-GBw at 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)^}<Cr_&1de=uL?`%-k;iEoXJN%~o|
zq_?+s(^h?;SflVO1_nl>o~|xYgq-xJcaj%ynk43B!F-NSUUv@<ko(kx+))DaI1>K&
zrZ4w3nXe^U*N2~lzuY<Z!5)*7ljle=BixZie4e~6Yb=J%$1;U)D-qHQ3U=S?sA_3y
z8n9?52!;E4Q39y|)*}}$ohjm7qkUZNde|25ECe`o-s8=|r935e6?{QxXm3Q8sBcMr
ze*Rm?Oiggo<l0edZ-ghgF4yUu5{tXhb$OGg^Cto#BEgKfU~!aSpb`z7<I-b3EeFXm
z;@hpYdE4sR*yNT>DGU#8_xJV=K4%`6zZ2l&<NMTMpN66TJt{i-H?ZLC^G*w@?34&W
z|JurSxG`1IT4ucQe}es5S)XPOrrl<Ec_bGU*6!}^%3u476R_1w%JZ+I;xvbcN0aJn
zYETh^e$dFhupV3F&wQYx8#B|-j*cE0n|*n~B49O$e1rCWPBAwuR+Wcur}?$$m<GL`
z#Kt$^*>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*5ZvVTpoQaW<vL)DbqYA}0dX=nyX2V;-n3zH&{PrL75{G!^r-xaYnavDS>gwty
zrlx92!^8VC`xKK=K<hJq6P!s!?oKm=q@<)cZ7#N>>{pNy)$1HrANC7IGmh}hVc%x{
zJ+UOoIZ at 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}>T0WR<S&Wp6<h0Fsr;TNFy_gnI!CgbgK2sazLv$_DBPs}I11=!!Dbwl-HsT6
zpJt_F2$Afk?wx41=*Z4fg$~;eLLGGC=yZfREZBwIpJuJpDJ!9+^z^mip&?tHq&#d~
z+ at 6L%;@-=St6;c4A;?&tEiI8U#xmzS{2!BNvn*Iy%Tx6Mlf{vX5-&H_!j!7*7i+Xz
zJ&%2cWar=E<KxFth#C2J_eP~bFE_7Cb#CS>426voY6;PM#3d!+_4M at iP^dCq+FWT9
zvAdNB#mGs-TI&KxCSvvKeNs|V3iY&vfTe46JUQ_JkP&WG at q+K;*^g5<ZjT?tJZW54
zg{)3FjvT)A%S-qmj)lo;CuwPEXD#vE#O|RbpO<R0fn?1mkDYO`YOC=qI>0w$td?zn
zn;9mv8wa!t8Jjs+BqgV(muPE|5QPUfG<e({3wtj4zdHU2g3D1M7i%cb$43M3!zW!`
z*0sR(KVPHcum-+SL?k3=JS%7NJFb90D2VV{d`fduQ$F1U<~znnNO;+^0sHI`1H*L-
zJ3V}@28clkg^<jI<YddfZ50Z!mcZPt>;2%|fp}UTo24rjlG$MFuZr*4*<j6P$fecX
zo+k#T)6KPGKwxMt>|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 at 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 at b@b!q73%(z3eP`HHCAd?AwYPC at oiMaamDOq&*t?Q&%w&8QHU%
zgv16?1||zD>yG_OlZ%<wL4)Js*LAl&p5M8 at k*YK2?)*Al^JCrvIQ^WvhuZz{>R<_o
z9$I$`>$iyTZQhrbn?p&=+<pV`#|Jyd81p$&N95K(iDg}kbO$O3w&a>|v+GWwjpY?I
zq<!9V!F<okxR^aiO|^*Gwrpw7H?QYPN at ED$nzI^_&s#=XdJtIKfQ3Kvi~UGahK6!L
zUaL9$6?^r?s*_RU%Qte-hv_e7{{GdrebM>$<=$W at 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<!oKacQ?m>#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 at 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 at bbF5Lm-%i
z4H2!d4*yb98xt2!5$fN!Q?!a4o@;GOaLQ_GKY9lSbQa|$gV$rQHk5i9(d(S0i?fvi
zXBYD~?rHC9 at P9_YV{=JX&vp$HqlLo%Jq*YWEizx*22a;8quPC#W^g at 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 at b3h3&^i#0`;L=jrLUjnZcj>uB@)$7=GT1T
zzb<TBu}XY5!j<}{E$KlYG>N!w&1mDawpni`0<v$d*~vJl`KqL(G*PHRLDrxj-r{)*
z`3(h^Up)h*NyPu*Dk(2-JEX0xjcGm|6%B0`9Rs5kn8-g8I}uu5cXoXmad~+g!63b0
zbdZRs==oU}LLD!6&tHwgxzQ|MyY`Nbjtd|VAOn4U^_721;PdfxDhw6{tj2z=clbZ#
zHPqIWG;?N`myg<7Sps$&%S7WlUTYWbKe;gSyq#TLhraR5$<9u6wLQaDV1xtF>hAFB
zw|T@?R<ST6ET%MASn*q3V!#Inc^u8L-dddw+}(X%d%E9WsNVY0(BC&(sxz+rbh at _}
zVRCYkI|XY`Fl8JyWjAWkw30wx4yea0&Ci#K at b)q{Ktns4X!UgJ`0-;>0f^a|bxopM
zn=f at LT9l>ltN}jXJgl8~vd~d`R2P!aSYS at 8^1JRt=}1A&`h8_1NYzAFTNa-R;46y4
zHE>}-p7&W^+<9TjghD9*dxjU6l!Vv*_`bNfsP6yoxD^f{ryz1spY2guu}x<I!jl8R
zwvM|!ZjXQS*@{A*FHdDf`__!gtmT)pv#@vX-tAU(4^|r89KpoWN8e$B@(KzBDn0at
z8>-7Lp!L^~`8W3u50Zl%aopV8NsD<vWv_Hq)k2J(oS8B2Gmu2NxV+p$__H&dG76B9
zPY$O*oPC^fn%tc1fMKgvN&cV@#RGCx>uC at iLhNE$sGr5GS!(O!nI7D6t$fDN&zzRz
zWCGJxf6OaQotaOOfgnLl;=06Rp2E>RsHOhNL3Xy?(9qDmJ(8xWsp$Y9z>til3tnPp
zG;p9J`1(Hn74^NrL%%({D}N#epeO)VbCEEJ&4>CW3 at 2~djXUZ}c_*5vsjKaoSeThL
zIQY3w5kbpsp6s at 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(B<Ueh7
zkPAy8#IcDs6S86_`*R}dUB*FK-1TgJUQt!2kCDQ&MM%x!^Xf7NCD1{5P%tqA#$=-b
z;o*Z=T-0QT$1$<JL+P3Wx5b4yz`ilVk&wpG(9kdrOL7_Wt*7#$q!zA^B;2)jow2Yq
zJyFSpJy`Diz at FnLtLL<|v|3qy2?+_0*!X0tP5t5sK_g`>i#Nwh{!FZ_7JUo|Qc?qo
zDQx~};Ww~_T%XJP>j417X$pq^iFA7MDxOxDejv}J>+dHL6cil#55^Y|d=V2_$<agl
z8;LVGGD7;Y{WqcA9e-6_Pfv(`cad9$&qj*PASko_c^=kvd47IyLCrVE!p=TkR#rB$
zGBi{&a6=|+YP*z$dAtl&Qc!R$Qy7elirVS$dDg4Y*03_8%{KtF0)6|vqgx^(m_7S-
z>V8_s@?MZ0O`5F9HJL+)r0(ftZiI at 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;3e<sVjwyXqjMUCqX
z0RaKoiA*1WAV at 05RoBqCoCbizS35nc=>p}W?Yh>~CNCis$<580e8s at Dv93v%gTD#%
zFfreoe|@X1p09p4|I$45^wOCw1v^&eVXW-z#-)5aySo9VxrNnH*ndj+Ek}P5{oOiO
zSd1UJy1Fuw%FOIcZL<q69|->rx@)a8E}H&WXw;1 at fKDt8%C7%0*|WK6I(HAK1N}2~
zV|jTW?jWhyER2l0rPFut!JxUhxg)F5bS<I6XesK$k`ne%$s7h6JZ-_xFgm&myJ<G6
z9>VJCGBi|F*CRx0kDD8r at bGZ3J;@*kx+AQ))^nlCL=^6G_uYA_^&T?l>`-Xe!!V at m
zTe~O(`OT!GVe8u8(a~9p)_{Q>*O*vkWjjCS$c6?!A at _Y%b4$xzjf|Vp;$r_507I9^
zLp`IPq6;9<0O;|pMP4CRahQqZ&xD_!48y4aw=KiXh7+Gi<MuV**?zZJu;(n$<nsKG
zPaE_8+gg(iu2F}Vnp4XnAS6wUO<i~x82sX0hI}SOy77OwEC19X(%EoLA>idq|7}3A
zqBtK|zbDY==ZEV~CEtGwocm|@m5WMIq?pK at oSdQnYV9puE&y_kxQ?70z%LVLv++^F
zqTG?{0JY<fxN)F at yNBaD$tt_~3I{_6hrPy$`GHRqP@!5RF0LW7`{RWU!{wC`7BIlM
z{M{dP<mC_gfLs7yIJ at 4GHuO<S!_7$<URF_Fo{ER(iZY{aY-|jl($rlqPl?ic`}EXF
zZI#d4$EO?Mbr$mSQFs}_)LmP&Gei?(P_b`Y^bo{)$JG`+{pz<=kufp)Gl1%Ztfm4T
znro1<8vXSa6p4bhhe;%|AV^6`$;r)KEAQ?>i7gpfTztS07#Mi>_&EP|0$`=@85kM0
zgrNW=_y%~SuKUFxGsB8yJwm9-;B=vilOwDl4jB}zA4q0tzPo4r4GaeFdY-J9xMwA)
zqjtoP<uiF38TOZbs+J6Zt+fl%(#{GaNHB&K6<OQF5U{dkbvk!NVXK$JOI8}m%sZ|E
z&6C~nMnRX&-WR|dkJHOa8*HZgPrt3N*B6-`!YW}+0H~d#ck&i7Y8al#Ax0x$`Rvdx
zEhlF-USa5<g8WAG^HFEQ&z}l$-Zy1$sqz#;*noJo#HEMCG65<;y|F6LC74u!{uDwc
z292bG+Z|L at Rn37=uD|3)N3gN60dnUrO?7otJzQ+(*@=lWDXshdc(UaiT_vT{?(Xgl
zA|fJXJ0C86IXU`={?QCN{RVpzrjv>iG$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>N6<L(uI>Z6=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_((U<P8edslZuno%;0lyrei=s#v;?Ru(vm`T1IF3pzT0Ae~YfAsyf(EUqAaqMu`AY
z#)!M@{K*3d{Z-Y~i~gJ+@|J+BzP`TLl0_*gI?IRu$R3F*?Eno`y%_-fQz7pD^(NMz
zKU4bo`K at pM6WIZl%kC_ra?H{q=kIW*&(pSij8B_x6_+!=?OdJB?)VCsrKP1EBok~%
zAAs*G+-d`4gVMmgTR3rjZf<0E-g?T0jY~WHtUm(-$bh2ea<x!he=PikBPlt#U(CeQ
zA?(BS^z^cj)fg#_BnqG=2kNhee#ZhZ_={LI4;lc--_Oa2E;l;#gnh>jbaT5T>rAKw
z+9pPT%V3s_kzv%whj8{6`d#mwZS<&Q_4j at R$cn)JX&YX$3E|m?58!(HMc3Y>QXPM%
zl_oV*5Wr8L9UMNjn7;+A%jd^#K^Pv~((<qa^iv3CWJGfZV!KwF-CO{=J(- at KUU;Nm
zf+P9)^XGL6kLL$RfD4zTG=hoitT!Z=r6MphaZnIzIyJg+Btw<c`Px0M4`;K0S6v5-
zV#9wqrWPP-&&(i7Dym>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#<UsQzQps`ajA;c5!iGyVFucSPtZOKzFc-Bj)emGwqGc
z?+M5774(^5u!mJ6ynd)@s1bsur`xhqQ^Ny|nSfI5@}HKYS%xqlyh4qE_>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 at qGbwfc4l
zRMPEw9^Q;jMU{C?RaFlE*B4P5Y!pgb+BX0e0))~U23ZEbm-DRwO<axXUjV5o)J7B)
z#Kj8 at 4nf+0LJ%Hq#g^*rbYSPWbmp&Q*BT0fKxZJ`rWoKIB_$4mr19>6AgTi_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<CzmSZuDEKo>=jYCzYlkBhhd(?dR+cN**VkE3(<v7PcSx8p
z=gwh~t+dHKb$<1ghdTy=aI^l~3lOKyWb5GQTAd#(@uLD0YHMdRX{nr{hR~B7#YWQ~
zhZyvddo=gWgULB6r#R|-mE50{AMQ_Gec+6IGr7lH2JnPp%uZdLe9hl$X?rH~Z$KP=
z&QO#7a`fT`ZNa8=ekY0LI>!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<pme+7wzoobfMdb(5_mQ`9D=>`_B}YsDJSBr3%UYb=v*zC8x42
z6c at G2_4wlb&m~Q}M&8o-wCF`8!ZW_Dp6ilpDBwse!P;NgeTBESlB%%xfnL8&<g#{{
z<gF at CiVLlds@|mT+(7l4?WbVqp}hC*{r%R=Dr(-MT_nqk8Wb6Q{`s>*Iw}Z)t7CHc
zlQB*%o^;XsiqJTrJVWRCl1N~!rz_(>oAB^jx5ls1=$xQy7kQ=pRO?s`yiM-(=<~un
zI9k!vNdeZUSYnt at UR20)CpNwQL=20En+BnzXKxyF^#NI%E8jH&ot(?<G;Dy&olTw}
z^4`vB&Exa87l<WjJ+Mwhb0`(=INa98X0l)u-Hs>!siFAtIYxCG3|?*0LK6k<qY-nn
zN?tSC>abH6;G;a$WqB%Mc@#)yo~TY{$jUo3KUdI>jQPBgJnO$aB$b(k_2_RKIxcQU
z- at ykxJgAR;Y7M>t@`-LI^GabQEK~mzd^p$s0oT}DkYn55dy5=5I`o0mw3jZ{3>%7E
zyvSzUO>S>xj at M3f9?3!djus{qDh3t?SA-xFGphh^F+U~m!5?75g<>2Eu9z2%r($(E
zMTOVT5-4Fmv`!Tj`!OOBg2q}<J4b5mx4^yOWWldj8*b7vAZ*IrIkkat8slH;CGw0~
z%3jV9pg%Q>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 at Edy1BeDHj!
z_w%=0YUuDZz_<LhI?8 at T6;q3MC49%uP2_t?r{M1Q#Q}L?dq`OIa@?ws_lQ{DHjqp_
zzi&K#%aG62vuYr^y1Html2)B<X9z+5S$=h0RN;u*BF0l9+jaS{sMk5aacSeL-})K!
zX?xEd*ea31H#s{>F192!+`qIL79Nf?J2jKHq^GB;BbTy-;k at R|$^;pito74>UU6~U
z5sG;H&RNhetEs4Xr0C<o%DR-JSUJHtP2eZ->a0(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 at pGQy7b_b0UbcN5i_TC5g7r~m`AwY9n2QT32Bd)^ZA1DAV!asN_;
z*(sQxSOOmul8FJU at J%6PRaP#^FP7)!<tf5626pvSs2IvAd)_%7vSe}1`Dz{|hig7^
zp8`QytW{XC==OxgFt7L95L~su)0j=T`R?bJ)AT;h2uG31j=>Mx)I(u<!{cO{AO))a
zo#<yGk6Rf(bv?8W2yRJE4mk}YBV0I_*UQ~n=z&=q1iG~K&7Ho&>|j?amBVkMY`C!-
zp|(~`LP?2K`6^v>PE|u0At*8Q({e;(w<+A`so!LvQ1pBd4o+9rAFZQz8dHKpOhe;!
zyu4slg&!H0a6cN^-yr<?x|#%g@!EV+HpY;#;Xv;z9GTIDbsF=oy2;KJ`n}CcM91U3
zD*$CX at D*8yH|DBA9p^MG@;->8NT_!+Zxuxf2Vx#9FfDuTUc~pbCZjd)`Xzya#Urm8
zIW5gB%k4aOyIR>ToPHhT<2~=T8@>#bRf9M at HSV>Fv=Ih^=wLQ!S8UVpc>6o+oWHQu
zWf?UT7!igh*pWjRtq*PyLKr)#<(<8 at -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$ZdZQ<z{3KkC=Z1KyHG at z`I`tVGcT~$UVKF)AD5l^lK?lm#im|)|
ztzS<&@8zl)D=XU2_kJ^OYlKgfgs5EyIJLeQn_5LG4x{lOgNdDAr>Jz@%yQL)^bVaA
zhKE$u6WIw|{pLrz$hWKz{$wRkaq}kO16ES%t^a{AI`iE~^TgOU<HxK9rTGW2<%g(d
zl}|io2X~$JF^=&az6xP at rtj37C7B+kNp8_&Sqti&@<rp+#gz<p)3k)${55d5_&mq{
zZI`2qcopX5CDJg`q)b)I!Nw*h)jo)D{Zu-4wOg9|$S%#maL-2i6+7L>;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=r<X2{LSJ&%|eY*Pr<pBtrko=znbz9myi!N;Xb
zQRK!W6Ad`rS*)ec)p1zjr)$hcG^h{=A6>T8=-*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%k3aj69bW6xAE<G_(Y89d-(-HutZewZL;}C<;-!bEm~*cNQb|fy)-C~I
zL4TmRl6rZakfj&_hZmY0rQ`;EqV*z#lhLS!eB&E?Jz~p$2@&GNt3$zKU}JnZuyLi%
zMOfZ&gDuuOHDi)ua=kOYe%KWDOKC;|@#qs8r){l1LoDw5%x8y?yQ3FV+x at o2cmsOU
zqhg}7>zY(q*!kU<KwoT^uPCV)Mu!8wkt3|$!Ue%1JD!c(<dfbdsRy+v<YLjv+}pC#
zu$Lf+`&jPs1gkQX6qP)mFT`u{>J2b4u^y?QOpG)=zobFt&Idf7>Tg=ipV at wic!4bW
zRy(7v`%yx_23+a{5N at 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<e^nMLYSnkBTV|UFk|Mz)c|}5jlct=eQ_+?i4GF
zj)p2rC-qj%aera4wsC}ln}d(jFhv~+wItmQZv8CFX`KH-N%!nMmL;p)-MM=e1uwgd
zyu^th$nT@#2?i)07ry4v-M&5P-Phg)IZ-(0-<w=?@Q8HBzHFL5w#XQnS-V0We?&0k
zQ{U#|(y0!K>&aVqD`T{M?S==oEO6B}sVzQso%ArdtVVVzAL)DGbl=Oqmf}xHda%hn
zHarZxk)*nC<I3~Fbj~!bpo-`iqbY6p6k{B{>iy&zUW9_IelgS?L+^?7OlyOppok`*
zmY?KA+j)N$MnH=g8Z;z-N$8S=n4kE2d}7k-UBb`w4|KFd0k0q0ymKjTAL?Izlrz73
zDJdkium6yf9NkTUp6^BI5wN%sgA*e_DlSpKn6dtxK at Ivd>qgoZ(F!@4=`idabg8XC
zsxZ7#hD(MROUAuL3HmvuP6aAU-www>9#_^*PGMwVW&3`aS?enO at c55SM85cE;$7<O
z^hyh2q^rysHCI_~#L+|##bpfTP(pusj6{ar1E=Yx2o<Qek5+SwU}LFr^hHnZGAriV
z7sAdt>GTs$^6cXLI4H-g;G2M_J^#%Mj-E}{<e0z2f$;el-<Z5E6m=#F<$VLfs(pZf
z5;GoyGBHo$UhDRNhN7HQcOecu%A2o#4o5%wObr}as1Q}UPZx0|*RUl`I|H at Zbi3(8
z+dhQO94vw*QP|c{DCR#J5z~f2&)B$^KPnlZwj1`l-wCZI41CMPO_&~`IfXrSb=Enz
zF at v(JiUz;KPfW};BY?Q)DBwXn$q7sS9C#`5CksDxKA|`FFKu{MhT+vybg=yGR;5qv
z*;v16e}qtzV#b#JlM5)%)lSLtGR1;hH+-snlcaE#r1(M}!3z3Ba*!%7A046|eI}-I
zYBQfRJV)2^khGRaMaOuw(BMA5&|AlXk1DQMIXlK0Q at 8>qyg6=1{W at iumCbN_mh8Qw
zz4^m`2mCweK0$BQ`(i0v6^T_zSk&N%Qp0pX`q(c`JTmdlx*D#+NTajTEj9OfgUt8F
zh>wrAv)z0eC#=O>^&-KIGSts at QPU1hHDJj=TVBwk&pe{eFfbX$<^8;_ at Wr+?@FS)9
z*@6E%A@|c)Wr5JJ49uRfxkJcJp=1T2$~zxf0vKX{v)9o&wYLp<s3etKB7Ia&LW;Le
zo89kRu%dJ*2e1bylsStT-lx~9>x4K^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 at M-lLSu?r=bs{)ytDS_1A~GKA62I%ZdRREV`GW*
zDq4&1M at YnY3fYMAELPsLSCWMWCtvvBK$<oAj`*Abws6hR3IDg>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 at _8j^eo^BQAsXR*T-o`py$Cj``J(zQ(njRE*464?
zL*GTKSTeD{zC9216>K37nV8MDn-E!#9Cbs4xY at MeQN_aF-d1~_n3=4^jn*aY_iMRU
zYqWhbUKwXY4-W8Uo!Y2^h}L<(*?2hWYXq<f&j#1rc_5CZJZthp-(N%>NyXe2k1b^n
zMKL2nO8L1Z7!eqC-&_%{FaE%$7V&2%$JADyTpgJxlm2Mj3Gpe!abf;a6&X4BS%C;8
z44qImlE7i<xZU+7k)8 at M_IvPm9H2*>eI+OQ-DC*%YJb1yYin|Z338G0 at f1n<L^<pC
zIQ2K_p;CJk`dQFs?Lm%xEsxLtm92jA(X*JD`A(8iCWi0W!w?gEVz_8x<Zqb73(CyS
zE2stbU!;}jpbyqa!D(3CQMA{dUcJPTi|KY##eRpo%mfc{bdQfWc8=d1*tI$aE~JtC
zn0(&M64Q$R7Pp9_p7R~`O*VSZbFxa39gQRv0yb)Rjypn~i`(!#Sq4cXlVP>Vc##+;
zQiWdQ<@ZeSKVO(wnWtG;n8MrI{1^p(e<LX_F&6UOJj+MMxt;K at 5|)gA+TIp`JBQUR
z`_FI;gmAJah`3#%-Mv$vqOG}5xV5TSA)i>)WX1)NmJNl}-jy%wAc{}h1hwm!+WLI^
z{ZrkcqDY`;CtB3j%*5Azpdi1|GmCAWB%_f}k=<IeE*13+X;$b0f8*u3Kw>&!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<G0Rak@^xLS}mKg827DQ$+Mqr}7ueyP+Vs|}te0zL0N+%Fk*;vT3neO|&#
zN_M67`k5A&sC8P;aol$Fa_lz2ZSUV9E-8v8U5EIGpEJVS^yfh`0YMB(aAdkkt&ZpT
z%(U%O*XlCU^YeL3W9LYt^U&b5UOGUSb?6s;pE*w|;(*-bb~`zK`hoD|YAbky>@og1
z*MsSo&{Zxbe$(DOGcWx&=>6^~|F8)?WL{BNYW&THm?8`T1LG=C;ujJDk1E0haS at y~
zASk+ at tQBdPy9qc+%g8{Zon at w8#<24+t|$s*G~{?Wa)ODA{`<V_T!~qh=)- at VXIuvU
P$ODp>fk;<Ke*XGD_8~)<

literal 0
HcmV?d00001

diff --git a/Documentation/automake.mk b/Documentation/automake.mk
index 77c39f1..9cf67c6 100644
--- a/Documentation/automake.mk
+++ b/Documentation/automake.mk
@@ -4,3 +4,26 @@ docs += \
 	Documentation/group-selection-method-property.txt \
 	Documentation/OVSDB-replication.rst \
 	Documentation/release-process.rst
+
+EXTRA_DIST += \
+	Documentation/_static/logo.png \
+	Documentation/conf.py \
+	Documentation/index.rst \
+	Documentation/contents.rst
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+SPHINXSRCDIR = $(srcdir)/Documentation
+SPHINXBUILDDIR = $(srcdir)/Documentation/_build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+# TODO(stephenfin): Add '-W' flag here once we've integrated required docs
+ALLSPHINXOPTS = -d $(SPHINXBUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINXSRCDIR)
+
+.PHONY: htmldocs
+htmldocs:
+	rm -rf $(SPHINXBUILDDIR)/*
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/html
diff --git a/Documentation/conf.py b/Documentation/conf.py
new file mode 100644
index 0000000..63f5877
--- /dev/null
+++ b/Documentation/conf.py
@@ -0,0 +1,338 @@
+# -*- coding: utf-8 -*-
+#
+# Open vSwitch documentation build configuration file, created by
+# sphinx-quickstart on Fri Sep 30 09:57:36 2016.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'contents'
+
+# General information about the project.
+project = u'Open vSwitch'
+copyright = u'2016, The Open vSwitch Development Community'
+author = u'The Open vSwitch Development Community'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'2.6'
+# The full version, including alpha/beta/rc tags.
+release = u'2.6.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#
+# today = ''
+#
+# Else, today_fmt is used as the format for a strftime call.
+#
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'bizstyle'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.
+# "<project> v<release> 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 <link> 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**
-- 
2.9.3



More information about the dev mailing list