From 72348178feb4b210b1cc54d502ad193b84af7da5 Mon Sep 17 00:00:00 2001 From: Jessica Wagantall Date: Thu, 6 Feb 2020 15:25:50 -0800 Subject: [PATCH] Migrate ccsdk-features docs Merging this will create https://onap-ccsdk-features.readthedocs.io This build will run in parallel to the current docs generation method until we are ready to cut over. Issue-ID: CIMAN-364 Signed-off-by: Jessica Wagantall Change-Id: Id4195c72229e798a771729ab09a93a8c76becbda --- .readthedocs.yaml | 20 ++ docs/.gitignore | 3 + docs/_static/css/ribbon.css | 63 +++++ docs/_static/favicon.ico | Bin 0 -> 2102 bytes docs/_static/logo_onap_2017.png | Bin 0 -> 12278 bytes docs/conf.py | 495 +--------------------------------------- docs/conf.yaml | 7 + docs/requirements-docs.txt | 15 ++ docs/tox.ini | 22 ++ 9 files changed, 137 insertions(+), 488 deletions(-) create mode 100644 .readthedocs.yaml create mode 100644 docs/.gitignore create mode 100644 docs/_static/css/ribbon.css create mode 100755 docs/_static/favicon.ico create mode 100644 docs/_static/logo_onap_2017.png mode change 100755 => 100644 docs/conf.py create mode 100644 docs/conf.yaml create mode 100644 docs/requirements-docs.txt create mode 100644 docs/tox.ini diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..3797dc8bb --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,20 @@ +--- +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +# Required +version: 2 + +formats: + - htmlzip + +build: + image: latest + +python: + version: 3.7 + install: + - requirements: docs/requirements-docs.txt + +sphinx: + configuration: docs/conf.py diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..43ca5b671 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,3 @@ +/.tox +/_build/* +/__pycache__/* diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css new file mode 100644 index 000000000..6008cb1a0 --- /dev/null +++ b/docs/_static/css/ribbon.css @@ -0,0 +1,63 @@ +.ribbon { + z-index: 1000; + background-color: #a00; + overflow: hidden; + white-space: nowrap; + position: fixed; + top: 25px; + right: -50px; + -webkit-transform: rotate(45deg); + -moz-transform: rotate(45deg); + -ms-transform: rotate(45deg); + -o-transform: rotate(45deg); + transform: rotate(45deg); + -webkit-box-shadow: 0 0 10px #888; + -moz-box-shadow: 0 0 10px #888; + box-shadow: 0 0 10px #888; + +} + +.ribbon a { + border: 1px solid #faa; + color: #fff; + display: block; + font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif; + margin: 1px 0; + padding: 10px 50px; + text-align: center; + text-decoration: none; + text-shadow: 0 0 5px #444; + transition: 0.5s; +} + +.ribbon a:hover { + background: #c11; + color: #fff; +} + + +/* override table width restrictions */ +@media screen and (min-width: 767px) { + + .wy-table-responsive table td, .wy-table-responsive table th { + /* !important prevents the common CSS stylesheets from overriding + this as on RTD they are loaded after this stylesheet */ + white-space: normal !important; + } + + .wy-table-responsive { + overflow: visible !important; + } +} + +@media screen and (max-width: 767px) { + .wy-table-responsive table td { + white-space: nowrap; + } +} + +/* fix width of the screen */ + +.wy-nav-content { + max-width: none; +} diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100755 index 0000000000000000000000000000000000000000..cb712ebd205e6101b23c385f1e3a963963979dfa GIT binary patch literal 2102 zcmZwGy>25%48U;)2xR#!ro1P(dXP><8kJEqkHS)=)mc$9J{Wlp)_H~$1LO+H#sLS* z))gr>e-3x0EpDXWa(Bp`{Sfur@1K{_$LC)~KCzcZzsQ(i{^vtQ_=;)-w(N?TiTz{p z{qMh6ETe!#sxUN>EJ$D{7bq$WO{54CGB_xT3PT&On}`_&iV8y$VOMHGMuDQj(6~uK zLPmk2!q7zcN=wKnP*fP2WZ^a?!9N9x3PX!WONp3Kpr|mkc%vp%> zZNK^MW~}J>ICz2~Z^wgK{=~QzOb6Gz zPcX(y!~xY)J|=w2%QU;gk0>;1Xzy?>bs z-u%X9{pm~e|IT|hw!= zame>@Au$8~vk;R1Eu{`B6#4CBIR=760t2LO5Vim&q+**BBts-Y+~+PUrbj(^Jd=wReA;OWCfwfY4cGypmncwUU|@-eh$s%s4+hz+ zw<{LQq|xs;YJUI5`7WiTg!TzSD6jEXsmfHNmfGv<>va)tJGEiMO3l)#`kBjVekg2c zek$WWf{^CLh%p3w8e*e%v?j?Rh3<~%pPjuhWvi8j(kVKhlga}`d^RSnItV*Q$AaI( z(G{=e6st|vbaO7FMl5(77Kx^P+?a&@$D!&~!<4A;6%=x&35z*Lxt*&}g!hOJU?Wnd^DHmrz+Ww*6c!SUk~abHdGE&)zj<$3qGTK@_7*z*K*c z!x!k)^L>j_aO3{uFB7a;)VID)z-Vhbn*3cjiT0PBy*((q241-y;_~*^==s*RbTgM< zsz~YDu}J#mx?2+c_{B$$|KrrrX0uC&`V5HNh*9fDy013Uc0@o)*xbMAwC|x9404+> zvM*CCpIsZnP4=a03mqN9+kZ$hkWo@nf+NyB%G0@>Ep|^%v~n*j+3=Rzoat(7?KMW{ zD>M=qblNd~7@V!uCNx?u9C)10m#f84%4T4wzcA>u4LskS)vPT3Ri1ph(wP8UVkD_*lJQ;H`Y=h2w$6Qw5*h_JG9%*~m@Yn& z^8MyS*TZ@PJn?9xl=E4G54l{2yjS0F_|7vit1%fV#b$qGe4I{(5*?lDy*jqR&^@ms z0fSz>hG`L;K4Ah8;9q0RLUauZxs*8!o3{|HUQ9?#9f%_nKVEM~L8p=-XC}E?Mpa#J zb53LT#Hu#|_bo4TNiX~E7^V?<#hsD3)*9uBp?u>=G!|eevR>r?6KJeUNfbZHuP(du z-L_K9#rVD?X!z=laBikyXm{Af5v9C6R$nz&Xf-2e$)%LA++VE9dwKPBkIG|WG^FTu zdN>}8r}a@)grQSi?p_B5+bitG-abbh&i62R^(RY>|9yrkD2@g#il#0PB<*HFM zn=%HyeNZiJZT#3-)-~$5L{9!0S0M0P&*M&yc?d{dUA^6fptrY|@wJdOW1>PY#Z_6l zWVY7%MD^V|G$P`+c8^`D6qRXs*5om1$*MtfU+o-Q!1!zM5Clt1}#Q2*;#L zE;`k*hL5O*WIfq&cT%-1cHj{fe*AYz6D=ZUbexcSf2MN4m@5AUeV3y_6@$d9TL>+x z9v-bXsmD0S9Ye?`rJyi{z%vabUC>WZy&h+lYcM}3;*oP_bf50^YWUutqymNi^-q#O zb)oX1-16wV#|x!0IBQ!wlP!UKNPnxuQtk2ilqSATJu8FFd^}$iA&teD#ld}hh$t&2 zk`AqSD7>o zB#90d7AGPkM7-F+MR8Bnf#vh?hoRb0CwnbJ+<}~yMbDpHZL?!CEY*xVxw^-4(3>Uk z>h8{XA1qMo`Cy|;{}C1&8|#0kwT2A7Vr7?hQ*1V39&Ksg*)9}ffaTgSZ;CMQ>iN+b z#}lS07c~5}gj32#*R;ujgf{yhzplH7Z=+^Zb#?WgPnX9&ZHCYKfM@51rvas!x;oAa z1zH4fW_8+}OtK&kJ0?uXn3!Ut33!a!XLY|`UeQF06_7A0FWNLG#K-Uas3pbp=*%AL zO)1su_Bn?u2e3fq*$_=vcNyhc7sb|>_8p(3rGVvNJ~ zopN_5W_PPsSVTU|y!KK^C70TI^M>VECW7% z+~8o)pFgz~n>Ep+Npy$Zo1~&S=IiqLkr@atFV6Xb=0t0Aw22NHU63rJke{i7{0$l8 zA}v)@in21KeK>eUL)fv0#R)^SvpF)mKHhmif}N6Kl3qOC&j^C5t~Q(7Ilk|4-VOq)5pfhQ)ATwPs(@-h|}mQ!zbB?Q{#r>DnH z0Fh_aV8BBW`P`CpSLlikM-$W~vaeWq`M&cKxL%m}K6+!+`6E5VBS3&m5Z;gp3`gR~ zAgPQ9&D1J2*?lxR!~fWScJuH!(E66IbeC#9L-}etak71KptKcG@nQMPTsJR~e0c=F zK|pIK5tPcj>j}DsxhK*eOU@^-Bo8O`^Ybe#E|!XC)a&A%$SC#frYZt=o^Rhf{;m<@z-K-P6-?7@`hv@kIAb zo$;8Lxp+7za)M!^=cCXdO6VKLZ@p?VNrq*!$@<{CA9!q5KT{a8D8?9dJ6d|YBcb3b zRi*WFZxy0QgrQ4rj2q2&8K0KZSWU0;a~pkuQYw3&?xv)4PnjoHV6aq^_j>=rL914k zS@eumw8*->C+TsvDPM6F*RKY7eu9MGK_pqX>`xv3B&H4Ei=h|V;m+=?ISgfcR*_oO zVD>=yKWQq!Fw-S=_EWi+Y?h)tln2 z=WYq}(TPvG?S-y+$go8+!PS(WH?vj~-58uP1I>&E^+8#a1skJN1_%vmYYWz?(%e_A%#ZTXNl$1B%JPA#0~kE~>H zns+)vM2%Db{&$IbCZESk(3WKBhmW5)lMsd`kaBm0@7`@P~D{4n}KQW?$_HPNZsv zFv3{k(Wiuo$-6>~_vrB6WCU4akd?`Rp6|5lhmR1;)0984LX|d`&zmz@zc}LX?3nU3 zN7WoU7^d$IdU9~ckw^3;QAX~{)QFtG<>KJw=8)M$ zP%Ho%X>XV)Wx7E8!7D0}@ibE%La6x4T;31r>w*E%rvsmL1GN z;nrv|Pj0CpDJf~S(al(ss-E zv|`tumB4JD86iDjh#5A63kTmWU$?BJpM{yXIQ#oTmokS>*q?cq+Brx_(4ZvFN0Hfb zK?YQ3V6YA4K*=b8N`N_$7Z5@|7W2;Lc?O!8h;rR<7k5Z2SFNO-nRJa96ncC+byb^H zN*ZI?q`(l3LpPX4TyakQ>`O?wtke^&@HrFHA>R<`l>gggtCoFB?oaA1i~xT`EWH+? z4CnSGk0+Zvldae0Jg=Z@FaB*-(DgS?t39ATg3n$mv|E)}G@Q=Y($FZp$U#lki>gXi zXg{s2@LwLV*M+AQ;}ipfOmYM!fypLFJC4gB&5GlIuzO$u!F77QdCN#qLBH7&F1HCZ z9jql0$!@^1Dk0hQ^_z`IDdQ3bGkj&_94tcb13GL6W;$KSyR?M(;bfLMfTl)I7sbBf zUS6+`4}@1&S5}){!ga5?y8+5td!1>R33$+hBiC0ry{rPsS!Gw-@Nm`tF5ndGUg<0H8ycR=fQIhx855f{Zi zdXZ{f5~dYVBxh!h10|H$oo6=GrvT6^RHP&cUeN!N|2wM10@I8ab4h!Uwq=MlEf03htw|`rvt&4B|gZi3T!taj90lhV|GjpeHo>0>uI` zr?ZtHJ>Mi3P2Zb??+uol*=^1zyx3Rp(vp<5 z)Zswh;;X5Ab@VU1PM4S)XlRxO*DUE>+9jkMSn~1=v|H@_LPKFe;OD2Jrxi@DtV@ps zOz#FvS2fJ^c=*UA2Qfm39|#VJwH$^@kST*vDdWV??fT_GDfw3$!GBTcN>I^axX{)FAuwM-w2Z#JAwmwGwsw8?_V(=2R zpZw*r$#%2%NM2l;A3jO>bfq<7z1`)oHFM4CD>VjunM!4P@$r7s4n|hm5f8MA2QG_Z zEZY+lB!&lWt!or{;ojr{N2+z;<}4Yx-x@=uZmaAcH&}#uKGO0Ow}VtxwP*X}fdLUp zU%scbW{vXs18T7f*BpLzdMqbyo#+pDH#dduuG`pj_ZxTy1^`n|T|Bct_M!2jhNe;6 zSE`#y&@jz=mPMo6Q{da{Q}YBQV*O_5g){U8tLsS)n7x#~5_4<>mdp9ohd`tSmt^fj zP>X!_EDPlTh4)%{FSv?z4WR#3DuVBPxi#4hj+#+@(rGt8yU009vWE(rEs=LToFo9+ zBNY6-k!`Y8yc-CJhYM-W4CD{@)c-P4Y7q_(kQhgopAYzYBt8Z722bnfrk0?yF!~Ln zxWoS8l_aK|4&@`tT1CEL8wwXI@2O0LPq^&i#q0qwP|=J=zWb4VP-yV^eueY{8W$k? z5=w^m=8l!BbkfQ6dAgl#;8Q}NJ2E+xc<&2B2&#HR!uhckghvI8(sr+|U9Fj-#0=A+ z{A=MeZNJb(06=`!Bp#9#0p97(GGVVB2lK1_{|7#*F!RoxfZkL}g?O z_`V0>U=wgRl*s379Q%x^^`Svt_TqZBNbGo{AH2APuVyNYASBn$v2YDGTF^6dG)Q8N zE4p~yT1aZZ!+#4RkRvCRk|MaN*v%A+#F1OBGo~1mPrrqN4#=BYalJiK?CT33irT0* zoyhxJ;Q4Uw#d?=f5rhZ?;=83HP#Qmvt=#e9|ML^}Ilopuf>;{&eU zYZ3KqcuYh3RM{r+GF8ewgT}B}`h1QNI~oS6&yH0i!X((29HrAk8a0yCJ<*{$RHR3F zDsWW!#zPRyW0^_tl7V-wX4~A>cUa}*eGW>aabwwUs{bmM>)pzqR^x%unQV7B%Jihk zzti4yedSJ+0l`8-0+uQ|C-?Y7_NJ(VvHLk57~=LVO<)DT&ag0z7{#;Z?}gW>_#>j! z!|Mb>F^3@3FI$Pj!sHmr6>@7Zh0d^e{5OVpnEhmNCwA%Fbl`!Zc$Mi5MgeV~Z3c6ZCwT`D;(McinOEvs7gipNNqb zb}zIB!vU8;j4K~YNj6#AvquECkWyXYuaTRXQ7W5DB$n2}L5{W`uV_yh=5)lu8c`|g z&+2+oR#>-|(i*eVqtmC~l+P{P1@U9}G&%J`Kez1fy_WKN1gfaRy*wW?$u(@TOCY)h zlxQ_ynkku>LJP!Wq&Sc^tu{J-PU1~wk-fz_0woNG+3<%&iGSJ>e31Wa3Ao1a310I0 z<^KHlKZAH-j&wDr+l=Y~sgfnsVwPRVy;|Rw9qk^<(%ZIP! zoKo=*^DVrb?PXF$@gzBj+o#L*M|aOw`?8eiK=J>5pZVHZ&B)E29uR^om23-)!{0TV zsHeKj=l-HvE>;YhjlZ}5yYt|%-RP?^5Z3eRiywm=ZEGjRhGOG@GPKf+uJHdeZzWDh zvvpQPs$nq5fUZb3EL$y-Vm4X3Oq12xgJV9psvNZbr3~v~{7%k7j=w_dXtF5WrzofWlgq8EJMm=<= z$3uJvx*IU-x>#-Y(k1Ek8iI1@8$AQ=rNVncU{dm)U$CV%BXPL29gh0K_vvuh%=D9^ zPqF=LR2;ZAn{38cjlI$uwlNf&{G;4!mqih;NckBY_L5Z^TH-8f_gu|RW)pP&P!>sD z`>y{}?)I0@9<|V@MRY~0mVAg&ub>z3jM_J?=9?AFO&%*%UAt-hmI*Kjd*jEf+HFpf z@vp9%-Z{3;CwCtAdt0%Nv&FJBdU;-Xx6~$)H60cf3Jb~a&(|Lezb-sGpQQaT$S=&W zloS*H6)O&ZhyeIIYGpsvlSoIJ%B`)&cn$RBCgMz&N`nf0%=vsUD158g^n2=8-f$aY;ECa;~>wy zP##;PZ74+g_Ht)>Fs>086ihPqS+Pr_3uC?f1vBmQRJkezUgEub)#}l|f1|e-UEdp? z4%=aZ*z zwp3l7&2Yw@+7#$XeKrMdO7wNoDNM(OtX(MWNLb7Izz?PxwaERbkO}H@a`+XgqdD$kpNnjv=ZVt)pyI9 z-&UT%jb(9|%6{6xDGa!av06vM{k40PvC?0eaAeeNH~Yv)F*w_CnIl$tJGAG=PhOyT zh8haYi{dq~ydN)7gAv~Y(^yRoT9xVC+OEVmo4}35^M4~zR-YSs`z3!FL7xD;ulwEn zD3od!Q1Gd#C6pr3{{Xym)lK6e_D~c`tlSWl+`-7)ceKF$DYgaMT+e1g?G87^cs(;s z@X+Z;1vOiV6TpMDQVPAtY~ObYj>XICygp7Xfzix+Mc#(nidxjP zwYD;wUFJfpvdc(Gky0~B)Oju1=-4|tdNv`*7l?65jVaG5gN<;H3BP@l{_r81Ef7b6 zM#lS7U2Tgs8uRmu08y3iV#bFx7pQHwdCKChCBqrkz~E?N0Rm1@0;w~`G&~t2M=5oF z^6{zVMl|L5)+*H*CwSUyZ>jdT7mqbJ92^|fY%2@ydYM|G)?N5%hfhqU+PTAbhA@$U zIF)+LfWh!Vn_&~|n=|bK83}|%g;Ap)beJu)m@Pb|e~B31JS~E$wE=e#kczJm*ZFj+C zIck#J{cdL~>{UALV!)OnjKn5cwY6+sMa@p2EB-IXVM@rZ&ySCn?=Rj@e>cVB;kz)h zd-@t*mRfHvN?bm!3GzdU6Hu9ov56Y0#NnDNnmwzvTSxn#5V-7jMDFpz642`p$9L`) z^}s2`=@lFRwMzbN!fXO-oP!4|BkMJvK8-jx7Nh_&HdB#Wo2Qks$h22H;Aa+>l7h!( z&>l&S1vtpOHGH+^WyXs9(4mR5)>bNJ28QSi zPFpD{VFp-pQ$p!v8OON5pdi%riCY0^3iJeOyT>Bj`iR$nPAQryB)MofuRRbk=a@;o01E8dM8 z$(2VxqSEnKAE5{~t0EG(eZ5gAB3jWe?RoC2UTvFscd%Vhs;qthLo=rL1>TB#c96DdmgX@28%6E9GaQ!ee zG)!alhCI3VBT5r+aA!%WP6tEy`J{f;(uG{0(YaK(4 zO&`;}zo>K7dIHiSq^eYX_vo-o-BaTmA* zh{f3S^yll7_Xv`3L%(8LhSTSI+6#?tOP?++my7(7i&1cn0GLWRc&0?&R?L^1du;F8 zBFTU9`^oh49p0<$ITptmSJL@~R8Z#e=ZkCIm!Xk*F0ku9c@$tTKym%g3$XnPH57?U z$5k&RNK8u`&Q))Miv8{6u~LObZ^-*z50DC!OS}?nhC6_T;3%BQBs#UF>k~?=dvQ24 zK3?9V`F0dKwTfKtVPrPnlkdZua#_4#w#PGxbPq>}t0e_u)1{84udBS*R2u+G0Vo%r zw=VMpPzfQI!d>D3-Z6i=#r}E^)KKW>|A#s})KD`xkoH&kR9Ali+oXYkK_U=$(fv2EJr>&u?=QRoLRD@tJk?PUvxb%7!yKD2L}e)?LH%|@NSD^Li)AV zA8ws!g#$IK$XC35Wc9n&RKBsaiMK$&)RegCDKB5=Bbz?`#>R%slLrf#Sai=tn3g*l z8d@r+DY9+n8%HG(`Ppo7VU63gVQ>t-AE2Q56JMUql}2a&LOE$tr*}G?3xoIZ!MXML zH&;29ESmubk2qi=J*GmMLT9#F`-Knax>A0XhsH#Z>A$*(zd;B1p%2H*o=$KQaP6s8 zYJ>K-#-eR2l*-)7MG;mStov+8VB0PFbiGf2 zonEFw+t=UsSM7t{=gA$DpPyf)T$kXF7N>2VN*R8jas6@&wnNNpiJW4WmwOpMEPP~4 z%;8#E{bM4v;9-@{<@L2gh2i=6IW>kt1EMv)pWX1i<9`}w^In9Q%RYa=7Od|mK+dwJSF{PnuIsK+O&YL0%wkP;9O78$wql4dUc z*YLMti`(|Aav)TV?S<|_g_iV$X5*Aapi_MA+HGV)Sr%~>#0=B zlUkO3aM&yXK=m0XN^CTdM)_1_;Jp~k_gJ)5{oXTcT3MiffCXIQr(=5Il zykaquW39%_S}pkaGPA=%)-D%ogKEmf`o1+s%V#dC)z3k|p|v}hGuQRqjgo;oS+y;` z)_i+DU8@av@VEnL(CJcX(@5wqa942n+-|Yi7w<5FUlmH{t(F_o{#@wB7PHkX#@alL((Q5S_1_T1#9xbB>37r%7=BQN-EDr|Vd}Nl$t~OH+t7|$eyU~sG1=n zSv(tSy_fy!u5q8GBqb}z=F$)q6H}_z<-=o_%PA|G=eek{dxzL#;liYSRxDQqV9jE_ zY%pC$na<_}JK{>0R&KwDYs#fuqTE(iRr9*poRWE?L~s8H$<>R-kw97kqS< zA3suEHJd4!nNa~6A?h3FU*!^pNd|_*?`qM2y{0%K`Tq8D4{+q9MpC}gK66RjlK7-@ zq9lL<%PsMqWC3IX_BOq4)0|+ayy0;?g-jYpQYk=6?>;*Nbn5d~`rpVe67v@9gW=dE z>Q_5v%1XfIBX#~aXK&_7n-tD*wo>d_EE0w`vd>b%@hyo~O{`RjO9Qm{Su;_51QWX;mlQ+k6 zBHAvcxX)i;SS$|^5uv|KPEK|_|0_rCYjwY&Y&@B>r}rQ9_WG-IcWjh2t*ChW2=>kX zC*K{82>{q&a|7euw?bFUyOYhF3{D&31kllqkDlslOJ>{MKd!Fn#Of}?p^CKArLInW znZC%=SwMZV2fBYsna9irkIs~$j*txLCL>IAbm^X@TJ2VcyVlzNGmdX%GF5^ef7zk* zItHq;cnJPE%QztdD6Q00bo9|1GD0*fB%MqPxS+lmMc^}9?pcjV+4GrTzFjC`PT0gg+ovZ zHerZnRyK18e6329QzqyBDh7Ocxu5p!`GoxOM0IiRfl@FXN(>8#xK4q_*k|Tc0NGov zR_*XOm6Q72oClQm00gv^g<*2C;%Oh-CzU6KL^#C644HQz>SU2QWBl>?`Fek^`pIdJ zn!{!z@odS_>%! ziPcm$V)Z7}d-C#HMM}NrI_>zIQ#SQCfOXG{)mn3+3x%X(_z2^W;(f)Xaa(`yU9s8nGAjcXG%CI%&zYwd3+0nAQq*5~&% zG{qT99srT@U%C_w9LWDF!>!A3RyC9SbsZTCbgT>yo!uR5Pdpi({VFhVWI zsvYQI0LsendCokoBV!9k3-B$OHEIq;Bjj4O)}_T83wiN!+OF+6*fE8myoHsQ2R}L1 zcP)%tG|uE2d}+E^*~gLp#%WtDHD8t%9TZ|ce{vfbR2=2!N%9aH9o`3+RO*iv^_)-V z(u}23KG^}ToRvn)n0Z6zj)43cs=HF<5?p>ONb8jb1FIe!ZJnb1nU(I3Ptqy$`;%Eb z;C;D}lx9w~YHiS^?I_IQBOsQHz~JsVp^4f#x`OZf#x6|8^=AUZ0LMwO7F3Q%^Z9xj zzcn8Aq@J5T3!Iyq8}GjOxQ%$R+QkOFZbK>_yCwG?9;bQVMfY22=3HWYY&YXN!vx_+0Pt*)8UB zt(NP6W&miHE_@$9dj|L)t#o>FQ(f#v+cQ>=zvTc>J2f>Gi9J+E9>M{yP_O#^o%PekZd|{Ua5xLM?VS+1tKmyiqhoKAGH5SLlBIIj#bP_Pwd}|ew^ZejQ^oW%m zuxNBR-Vx=nUXR~@iNaxzr$qXuSZ{(vcr66D=iaSX^lLTotsNa4^8NLoZas9`2>Rz# zzCZN$Kh@|70NufC+&&OV{P)~(HvIbK@jrqAW-oG zZ`a%GA0~C83AuzeQ8rSn(hyI9+RFuS6<(Z<(A^cUX`8O+5>#4^n(SgoL~+KO#`pZ_ zRBtf==qcPV3s@V8Ksx`M9|SGqmd^(-Tge?tdpGdB{T=`CzJjvtexh7`f80H`cibI9 zy4vWRD#>gK+IgrgNyDmq(=t7huUS0<2&cHCBb<Z4suQkh7 z1H;2SGxjZ>Ed{FOwX0{T69#vbMJNRrIQqt`DH>S<>ir{{B%d z_on4c02%e!$lv4~DLKoV|3q<(0-WMTEP1NsIWsMUa&1l#5>oK#Fj@~W=%E~QTQ_>}Ga)E=6zWb<)vii37;Gy)bk^j=31|uA?yR=u|&dO`)%q3FnH~06$JkX=v zH6=N@zNejKiwr}7daYr!&&1ye%}T5&vE4_$f{Tw9fBh+e(Q`Ud?k;h$bTtQu|GF*Y z&B8$|`!$oS>2}_*rPL*-h+46NUXyyRY|mF6!utS_k<_A3#>7F*55f v documentation". -#html_title = None - -# 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_onap_2017.png' - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -html_favicon = '_static/favicon.ico' - -# 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 '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -html_last_updated_fmt = '%d-%b-%y %H:%M' - -# 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 = False - -# 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' -#html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -#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 = 'ONAPdoc' - -# -- 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, 'ONAP.tex', u'ONAP Documentation', - u'ONAP Contributors', '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 = [] - -# 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, 'onap', u'ONAP 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, 'ONAP', u'ONAP Documentation', - author, 'ONAP', 'Open Network Automation Platform', - 'Platform'), -] - -# 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 - - -# -- Options for Epub output ---------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = project -epub_author = author -epub_publisher = author -epub_copyright = copyright - -# The basename for the epub file. It defaults to the project name. -#epub_basename = project - -# The HTML theme for the epub output. Since the default themes are not optimized -# for small screen space, using the same theme for HTML and epub output is -# usually not wise. This defaults to 'epub', a theme designed to save visual -# space. -#epub_theme = 'epub' - -# The language of the text. It defaults to the language option -# or 'en' if the language is not set. -#epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier = '' - -# A unique identification for the text. -#epub_uid = '' - -# A tuple containing the cover image and cover page html template filenames. -#epub_cover = () - -# A sequence of (type, uri, title) tuples for the guide element of content.opf. -#epub_guide = () - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] - -# HTML files shat should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] - -# A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] - -# The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 - -# Allow duplicate toc entries. -#epub_tocdup = True - -# Choose between 'default' and 'includehidden'. -#epub_tocscope = 'default' - -# Fix unsupported image types using the Pillow. -#epub_fix_images = False - -# Scale large images. -#epub_max_image_width = 0 - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#epub_show_urls = 'inline' - -# If false, no index is generated. -#epub_use_index = True - -# Patterns to ignore in linkcheck builder linkcheck_ignore = [ - r'http://$', - r'http:/$', - r'http://10\.', - r'http://127\.', - r'http://172\.[123]', - r'http://app_host:port/', - r'http://app-host:port/', - r'http://ESR_SERVICE_IP', - r'http://ESR_SERVER_IP', - r'http://hostIP:\d+/', - r'http://load-balanced-address:\d+/', - r'http://localhost', - r'http://\$msb_address/', - r'http://\$MSB_SERVER_IP:\d+/', - r'http://msb_docker_host_ip:\d+/', - r'http://MSB_IP:MSB_PORT/', - r'http://msb.onap.org', - r'http://MSB_SERVER_IP:\d+/', - r'http://org.openecomp.', - r'http://{PDP_URL}:\d+/', - r'http://servername.domain.com', - r'http://.*simpledemo.openecomp.org', - r'http://.*simpledemo.onap.org', - r'http://.*test.att.com:\d+/', - r'http://we-are-data-router.us', - r'http://we-are-message-router.us:\d+/' - r'http://www.\[host\]:\[port\]/', - r'http://yourhostname', - r'https://$', - r'https:/$', - r'https://10\.', - r'https://127\.', - r'https://172\.[123]', - r'https://aaf.onap.org', - r'https://\$CBAM_IP', - r'https://ESR_SERVICE_IP', - r'https://ESR_SERVER_IP', - r'https://msb.onap.org', - r'https://my-subscriber-app.dcae', - r'https://\$CBAM_IP:\d+/', - r'https://load-balanced-address:\d+/', - r'https://prov.datarouternew.com:8443', - r'https://.*simpledemo.openecomp.org', - r'https://.*simpledemo.onap.org', - r'https://.*test.att.com:\d+/', - r'https://we-are-data-router.us', - r'https://we-are-message-router.us:\d+/' - ] - -from docutils.parsers.rst import directives - -needs_extra_options = { - "target": directives.unchanged, - "keyword": directives.unchanged, - "introduced": directives.unchanged, - "updated": directives.unchanged, - "impacts": directives.unchanged, - "validation_mode": directives.unchanged, - "validated_by": directives.unchanged, - "test": directives.unchanged, - "test_case": directives.unchanged, - "test_file": directives.unchanged, - "notes": directives.unchanged, -} - -needs_id_regex = "^[A-Z0-9]+-[A-Z0-9]+" -needs_id_required = True -needs_title_optional = True - -needs_template_collapse = """ -.. _{{id}}: - -{% if hide == false -%} -.. role:: needs_tag -.. role:: needs_status -.. role:: needs_type -.. role:: needs_id -.. role:: needs_title - -.. rst-class:: need -.. rst-class:: need_{{type_name}} - -.. container:: need - - `{{id}}` - {{content|indent(4)}} - - .. container:: toggle - - .. container:: header + 'http://localhost', +] - Details +intersphinx_mapping = {} -{% if status and status|upper != "NONE" and not hide_status %} | status: :needs_status:`{{status}}`{% endif %} -{% if tags and not hide_tags %} | tags: :needs_tag:`{{tags|join("` :needs_tag:`")}}`{% endif %} -{% if keyword %} | keyword: `{{keyword}}` {% endif %} -{% if target %} | target: `{{target}}` {% endif %} -{% if introduced %} | introduced: `{{introduced}}` {% endif %} -{% if updated %} | updated: `{{updated}}` {% endif %} -{% if impacts %} | impacts: `{{impacts}}` {% endif %} -{% if validation_mode %} | validation mode: `{{validation_mode}}` {% endif %} -{% if validated_by %} | validated by: `{{validated_by}}` {% endif %} -{% if test %} | test: `{{test}}` {% endif %} -{% if test_case %} | test case: {{test_case}} {% endif %} -{% if test_file %} | test file: `{{test_file}}` {% endif %} -{% if notes %} | notes: `{{notes}}` {% endif %} - | children: :need_incoming:`{{id}}` - | parents: :need_outgoing:`{{id}}` -{% endif -%} -""" +html_last_updated_fmt = '%d-%b-%y %H:%M' def setup(app): - app.add_stylesheet("css/ribbon.css") + app.add_stylesheet("css/ribbon_onap.css") diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 000000000..ab5928131 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,7 @@ +--- +project_cfg: onap +project: onap + +# Change this to ReleaseBranchName to modify the header +default-version: latest +# diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 000000000..b3188ddd3 --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,15 @@ +tox +Sphinx +doc8 +docutils +setuptools +six +sphinx_rtd_theme>=0.4.3 +sphinxcontrib-blockdiag +sphinxcontrib-needs>=0.2.3 +sphinxcontrib-nwdiag +sphinxcontrib-seqdiag +sphinxcontrib-swaggerdoc +sphinxcontrib-plantuml +sphinx_bootstrap_theme +lfdocs-conf diff --git a/docs/tox.ini b/docs/tox.ini new file mode 100644 index 000000000..edac8c35f --- /dev/null +++ b/docs/tox.ini @@ -0,0 +1,22 @@ +[tox] +minversion = 1.6 +envlist = docs, +skipsdist = true + +[testenv:docs] +basepython = python3 +deps = -r{toxinidir}/requirements-docs.txt +commands = + sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html + echo "Generated docs available in {toxinidir}/_build/html" +whitelist_externals = + echo + git + sh + +[testenv:docs-linkcheck] +basepython = python3 +#deps = -r{toxinidir}/requirements-docs.txt +commands = echo "Link Checking not enforced" +#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck +whitelist_externals = echo -- 2.16.6