From 256683072fb4c5b0bba36ddfd273b9bab0213945 Mon Sep 17 00:00:00 2001 From: Aric Gardner Date: Tue, 10 Nov 2015 13:38:38 -0500 Subject: [PATCH] Move documents to new directory structure added index.rst Change-Id: I5af95b40afd5443176c1054085b597a435c31b1b Signed-off-by: Aric Gardner --- docs/{ => arno}/enable_docu_gen.rst | 0 docs/{ => arno}/images/smiley.png | Bin docs/arno/index.rst | 34 +++++++++++++++++++++++++ docs/{ => arno}/opnfv-jjb-usage.rst | 0 docs/{ => arno}/opnfvdocs_info.rst | 0 docs/{ => arno}/other_options_for_docu_gen.rst | 0 docs/etc/conf.py | 34 +++++++++++++++++++++++++ docs/etc/opnfv-logo.png | Bin 0 -> 2829 bytes docs/templates/index.rst | 34 +++++++++++++++++++++++++ 9 files changed, 102 insertions(+) rename docs/{ => arno}/enable_docu_gen.rst (100%) rename docs/{ => arno}/images/smiley.png (100%) create mode 100644 docs/arno/index.rst rename docs/{ => arno}/opnfv-jjb-usage.rst (100%) rename docs/{ => arno}/opnfvdocs_info.rst (100%) rename docs/{ => arno}/other_options_for_docu_gen.rst (100%) create mode 100644 docs/etc/conf.py create mode 100644 docs/etc/opnfv-logo.png create mode 100644 docs/templates/index.rst diff --git a/docs/enable_docu_gen.rst b/docs/arno/enable_docu_gen.rst similarity index 100% rename from docs/enable_docu_gen.rst rename to docs/arno/enable_docu_gen.rst diff --git a/docs/images/smiley.png b/docs/arno/images/smiley.png similarity index 100% rename from docs/images/smiley.png rename to docs/arno/images/smiley.png diff --git a/docs/arno/index.rst b/docs/arno/index.rst new file mode 100644 index 000000000..994a20d51 --- /dev/null +++ b/docs/arno/index.rst @@ -0,0 +1,34 @@ +.. OPNFV Release Engineering documentation, created by + sphinx-quickstart on Tue Jun 9 19:12:31 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left + +Example Documentation table of contents +======================================= + +Contents: + +.. toctree:: + :numbered: + :maxdepth: 4 + + enable_docu_gen.rst + opnfvdocs_info.rst + opnfv-jjb-usage.rst + other_options_for_docu_gen.rst + + +Indices and tables +================== + +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| diff --git a/docs/opnfv-jjb-usage.rst b/docs/arno/opnfv-jjb-usage.rst similarity index 100% rename from docs/opnfv-jjb-usage.rst rename to docs/arno/opnfv-jjb-usage.rst diff --git a/docs/opnfvdocs_info.rst b/docs/arno/opnfvdocs_info.rst similarity index 100% rename from docs/opnfvdocs_info.rst rename to docs/arno/opnfvdocs_info.rst diff --git a/docs/other_options_for_docu_gen.rst b/docs/arno/other_options_for_docu_gen.rst similarity index 100% rename from docs/other_options_for_docu_gen.rst rename to docs/arno/other_options_for_docu_gen.rst diff --git a/docs/etc/conf.py b/docs/etc/conf.py new file mode 100644 index 000000000..006603516 --- /dev/null +++ b/docs/etc/conf.py @@ -0,0 +1,34 @@ +import datetime +import sys +import os + +try: + __import__('imp').find_module('sphinx.ext.numfig') + extensions = ['sphinx.ext.numfig'] +except ImportError: + # 'pip install sphinx_numfig' + extensions = ['sphinx_numfig'] + +# numfig: +number_figures = True +figure_caption_prefix = "Fig." + +source_suffix = '.rst' +master_doc = 'index' +pygments_style = 'sphinx' +html_use_index = False + +pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')] +pdf_fit_mode = "shrink" +pdf_stylesheets = ['sphinx','kerning','a4'] +#latex_domain_indices = False +#latex_use_modindex = False + +latex_elements = { + 'printindex': '', +} + +project = u'OPNFV: Template documentation config' +copyright = u'%s, OPNFV' % datetime.date.today().year +version = u'1.0.0' +release = u'1.0.0' diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..1519503eba764f7a00877b9b8bdbbd37fd3707c6 GIT binary patch literal 2829 zcmV+o3-a`dP)3)28sjxMC?FF++Bq$U6w!I|Q zuDk75d^``ll?O5~(CmjEDa)%lO*g>n_g{0#>mC}Gzk+T4rzf9>j53xroI0y~C_9nZ zRT`GLg0kl=wSC&o>6~=+jNzR71<#dp4To_2s0>t*!h`9cI?8$fX~Qs`rR1m400P?y z90%)qtm)id4ONiKpFsI}ZSK@iJ|1rbWk*!DU!d(zDwO-{0ftjgEE_w%;rV)uW5>yH z_exeI%QmujpMCMW4sNM^@?x)fLqOrhd{$9sTgQ`d%yCO<1Iu4R`O_B4UJp!A_62MX zv+dC{T~-}GLx+x;{ijz!sH5z=g`on8=PSHb0@Q#SaG3%t>jDJstyjW^fI6$;(C9VJ zM0+-BvHTu^?J(N@qDGm&V(fERuzosQRFSAa>*vWrfXJ0P?>aF7?>Ukt-*BC%M;idD zR})ZIu_ASxwrtR%$Ly%uwx-ywh|=kCy{aTtUB<3KB~XF4LO2cx3OQ&Lq?yxFVUVVp z0PEI0KSd4M#7I7+3(=OHPzP?sW6{8s*)F2yL=?p|oPJ~?`#D}}PV%!7PnCdm2ZMFk zW>V&_r_iP-9Vh7N0H%W`WFN{S(M)#H$rw-?2dl-hr#TA2Yp8sVw>mO79!D;2$j(C9 zzXy*$kkgBc&!cDaj~~4?%jjHLfvo_Dkm|Ke`S>rtaK&a?_58uB@A@?~_QQr_jA4r% zdo6L~(X+|q1$xR6wDO0o6BtGDy;|9Z8x6|M}356(@zSPXM%I z0Lusl0BW2ws#XdW$sw*J3o5uE4yIuhY3{5zlq-KbOpogcel|5sNqChP?l1?Huz=hO z3SQz!l7IoUeXMDtEbxn7>nNR~-uQD!D>F?@CkV2w46eFk7TlE;cNI&vfdHD!z_ z;-^n$4()d+RT3Nj{MYwKT=-mO$Li`vcN)ExjLy|D=p^S*?wC11I3%$KjPkiq9dic& zD1XFAINVJI`no{?+x)D;i*#V%#b0@^6+U-r5gc9;H_K&CRFHYaqspI@xpfrruA!jPbh-F;K8f!CJmzV zLU^o+ux2fL(BTYxUP&*N3GW6};H`XywCO?Ilt`dZ<@y1lkihEFYh6s!Cok30j1p@| zA*PCL7qX^OJS8L`Cu6zNLM4H9hooAZa`}@)!U0$bFcXy=K$sXnq37#@mx`sb0!4-h zfeLNEv8FIi;>F96e%vf)rl-oBrvk7d@g%V6_BVf7| zS9#?9)}X;>(XRIvx@+2+Chn!X=v9g*FSX8@n+oz`TlVDdw|;)?Qi7qA@?Piv_~kSp zz&N9Wpt$LZ@;^pTT&l=jY6Ntv!S~(!0Ta?)fhieeICo6MH?;1D1P$l8DC}dpX`5a~ zALHCbvB>*ip9$1haUlorIZDD~fXnDY0!+y*J);b_d;*^%R6~F(+Hr^uC68UD{MqKZ zyQ#Xn1?sk9Ky^fF%h*#DhDrm}69BE&;9s04v@Bh*TZP#G|!E+Ltr=`%PvYj2Zzz=`e#qSKRysVIIQ8#7S=4&P4ul z16;dqQw`0;M;E8cz{eLz0YHF%!Pmr+uvP zEG{6yZ@RHP70GX%dWv-m-sHwqFa7pYIh`H<7f$Y9Kl$`$%G98dx#an({(_lPu>y#%;AjQuVEuIY|;4s81w z#Z9+x0(6IfO6rah*C;7Q>2IAZ=A_a?j=YvVm5$`A=Xk(NjTP=x_bf}^Nv%B}fOYWx z-+$w4&SwN*t#-g;MKm(5?=ac1cqys-LMUztGL*=J3S^`(fvTgaU|;f5s$9OWDi9=I z1mFZYUJgA`4`A^D8XT2Wv*9PAp~W{FPBzFLX_p|XyY7n$pqd*&g_%8ysUC{WH7f9A z{3JO6UdmNy&)G-!?s6LASmZx|h}zZ%u#N#NN6`>B>G!PgVok2wT@V%84C-F@)68XM zGW#x-jYI{2;|u+SY#vZP0L5w;Oh|yY!hN&Wg1h=3z#0Nr=i>Rt>A6e%UKe}1!$6_^ zyY2!|KE8hcHS9CJx}hwxL|L2>K%N3nzR5u_jZQK!y-@we@hOeIt`Go*-YJIn>X1b) zcSps7k=C}`RwbZX)CLv6gAir@0^=XP_$PXk@XgyVD}%}x-+6=`IL7!&&~sY=n5Ri( zAYfsMQAU@D!Ifo|}iQURGX*Df~iL*>ymsNDu7Cs_;TR&=~wSP z9+T$^YHUmnj8!iS9oRm+UBb=MKy;;sk-xOF8-RYdS%B~4aLpauf1?pPG zRovzD3f;9+c%BL+9>i4$h%21{H=dY~eDumzpn~LuFa55oXP~o9(&iJ!@#?aOQNC#m ze6EpDkzx5k3v5joGO*Bjy-?