From dd8461e5bc8b316d1bb4f6a4a1712f3033bd8918 Mon Sep 17 00:00:00 2001
From: Benjamin Bertrand <benjamin.bertrand@ess.eu>
Date: Fri, 23 Oct 2020 10:00:08 +0200
Subject: [PATCH] Update Sphinx and switch to sphinx_rtd_theme
JIRA INFRA-2742
---
docs/Makefile | 10 +-
docs/_static/CS_entry_v02_blue.svg | 36 ------
docs/_static/CS_entry_v02_white_512.png | Bin 0 -> 6616 bytes
docs/conf.py | 165 ++++--------------------
docs/index.rst | 2 +-
requirements-dev.txt | 1 +
6 files changed, 33 insertions(+), 181 deletions(-)
delete mode 100755 docs/_static/CS_entry_v02_blue.svg
create mode 100755 docs/_static/CS_entry_v02_white_512.png
diff --git a/docs/Makefile b/docs/Makefile
index 51d5b72..d4bb2cb 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,10 +1,10 @@
# Minimal makefile for Sphinx documentation
#
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-SPHINXPROJ = CSEntry
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
@@ -17,4 +17,4 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
- @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/_static/CS_entry_v02_blue.svg b/docs/_static/CS_entry_v02_blue.svg
deleted file mode 100755
index c3cbf0e..0000000
--- a/docs/_static/CS_entry_v02_blue.svg
+++ /dev/null
@@ -1,36 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Generator: Adobe Illustrator 23.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
-<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
- viewBox="0 0 2560 854" style="enable-background:new 0 0 2560 854;" xml:space="preserve">
-<style type="text/css">
- .st0{fill:#0094CA;}
-</style>
-<g id="Layer_1">
- <g>
- <path class="st0" d="M886.8,303.7c-67.8-15.7-130.9-36.1-130.9-66.2c0-18.1,18.5-44.6,72.4-44.6c75.5,0,78.5,36.1,80.1,50.6h251
- c-21.6-175.8-215.6-210.8-328-210.8c-82.9,0-160.7,19.3-220.1,53.9c2,1.5,3.9,3,5.9,4.6c67.8,54.1,114.8,131,132.4,216.5l6.2,30.1
- H527.8c35.5,45.9,101.4,77.4,175.7,95.9c163.2,49.4,226.4,55.4,226.4,101.2c0,32.5-46.2,51.8-89.3,51.8c-10.8,0-86.2,0-97-61.4
- h-8.6c-23.9,61.6-63.3,116.7-114.1,158.7c-4.1,3.4-8.4,6.7-12.6,10c70.8,39.7,159.6,52.9,229.2,52.9c189.4,0,348-86.7,348-233.6
- C1185.5,368.8,1031.5,335,886.8,303.7z"/>
- <g>
- <path class="st0" d="M726.2,469.6c-36.2,152-170.1,276.2-351,276.2C172.6,745.8,17,586.6,17,387.6C17,191,170.2,31.8,370.4,31.8
- c177.3,0,320.8,117,354.6,281H522.3c-21.7-45.8-61.5-94.1-144.7-94.1c-47-2.4-86.8,15.7-115.8,47c-27.7,31.4-43.4,74.8-43.4,123
- c0,97.7,63.9,170.1,159.2,170.1c83.2,0,123-48.2,144.7-89.2H726.2z"/>
- </g>
- <g>
- <path class="st0" d="M1312.9,628.4c3.5,29.7,31.8,49.4,64.5,49.4c26.7,0,40.8-11.6,50.9-26.2h85.7c-13.6,31.3-33.3,55.5-57,71.6
- c-23.2,16.6-50.9,25.2-79.7,25.2c-80.2,0-148.2-65-148.2-148.2c0-78.2,61.5-150.3,146.7-150.3c42.9,0,79.7,16.6,105.9,44.4
- c35.3,37.8,45.9,82.7,39.3,134.1H1312.9z M1438.9,564.9c-2-13.1-19.2-44.4-62.5-44.4c-43.4,0-60.5,31.3-62.5,44.4H1438.9z"/>
- <path class="st0" d="M1559.9,459.5h78.2v29.7c9.6-13.6,27.2-39.3,77.1-39.3c94.3,0,103.9,76.6,103.9,114.5v175h-83.7V586.6
- c0-30.8-6.6-58-43.9-58c-41.3,0-47.9,29.7-47.9,58.5v152.3h-83.7V459.5z"/>
- <path class="st0" d="M1895.2,523.1h-41.3v-63.5h41.3v-93.3h83.7v93.3h40.3v63.5h-40.3v216.3h-83.7V523.1z"/>
- <path class="st0" d="M2055.1,459.5h78.7v31.3c8.1-15.1,22.7-40.8,71.1-40.8v84.2h-3c-42.9,0-63,15.6-63,55v150.3h-83.7V459.5z"/>
- <path class="st0" d="M2332.9,725.2L2229,459.5h89.2l57,162.4l53.4-162.4h88.7l-140.2,373.1h-88.7L2332.9,725.2z"/>
- </g>
- </g>
-</g>
-<g id="lines">
-</g>
-<g id="rest">
-</g>
-</svg>
diff --git a/docs/_static/CS_entry_v02_white_512.png b/docs/_static/CS_entry_v02_white_512.png
new file mode 100755
index 0000000000000000000000000000000000000000..6b16ea7338192bb2732e7ce8b25a88d79aee1dd8
GIT binary patch
literal 6616
zcmX9@c|4T=6aVb4T&*kjy^^C`xs|Yv5Rx3ZZ|hnjSF(<!P_7U*i6}=la?6pmk~>Fo
zQ<NlE?wj4;eqX;oo_XeZKJ(1XYd$m2JkPwJm>BCZ(DTp(02prQ>zD!nrLf=~Ej5KQ
zU%Nn}oap@Ztph0wO8*@Y5zS&z0Jsxw=xCaUzFhl$8a&lKPQ15p<xtQR(g1x%Z*-~B
zEc)J=74yoFGxsjhzDG2~bg)xhvU-bn8*`EpQjsS=W`HPAtvHGt*z6%pSwZ`ARqy}%
zczk+%pJFs_f!r_)0GtUzu?*9p5F%iq(91|F3WX10?uIG#Rr|a|O_~#`dmWXpxLMcB
zlD^xJX1ZIo)wZWn7LM-MDUptI!y(`**RT??6t2`UZbyoA*<5VldH5|18QnI~FyPua
z7Arxcacn`d<Av}*xWS1274W=wE>QSkT7Mg%yc}+fc1=x~oS=Q{4zXXv&(KmU1+4Y(
z0Iu2*DAonobmt5HLYiApQAr$51syxKh<ofTjH9S38gDqzb-FZ=K)z@!$bY^xtEcc+
zdD0NE!8WlPbZLCA^ES^cu7wKvPN!NP_?v%$5VfdD&pirm)}Ny-yT+iikl(7mb5y^1
zemshsWOxSq&*d!Wl>5u+_y#yU^=*VB-&aEy@}t)F#~BUoy1844g484{ibuLf2-pZS
zHR<YL07ES-TJEil4&l)+t?X<e34jPIpaI%Bn;#0;X)`oO%X4tK87*nq1$O{4LyHmo
zLt$O!D)uGE->!hq#0oJS`Y@wchRR7r3l9FsHJ|5?u)#q*CCO`o1jnG5y>m(Bagjpc
zvv486LYBjAxv^t<g!Y7A>MIUKSuvv8AcnKo85vkw>As<HtIA?sriUttm!N$cc__8x
zcp<=YOPwHi6bqOM%yQrs`~+Vwch+~R`p!x7dK&4jtPn3ic&fv&rG-WDQ=XmmGJ4)H
z_i8(2bdi0dn?s6JKfrPlvcO%pxZXLxK})*I<t!?t>ecj;tv+h+3x@KNbbvPHDaa4y
zB023XeXjeWzA`W~+pRGxdVq=lBhmj5JnGy%M@&Cmboi}XfEu-mp{kbMQ!}&&AawB(
z?6UjDKEAvD#D^=K@f=?&UFCX~5x|->bc4(7@IL!?ghEzAaF+Y3Fe@OcPICil@<zBu
z8eRV7A%g7`4Q!*|of_Mw;d3(^)YCS73t|Gqt2q!bee!8s0eqG0PIm3c22PpfB3O}!
zQEV@=U<t?jDm#huME&={X2<TJvQrmq=+s4-6AWF8@xPpkaRrWiG|~$;Fs#{>At+3l
zAIV4%=+l_@bU#+FW&=c#e&8gE>1QcvnQ4dZk0x5ueF8)}ihfy|JRQID9yI2@znz38
zg0K4lAnk<$V_QJ`grLah(5_bRCsX1E#Rl_mV`-@43QxYKCO8aT=x(C32H^cpKd4lH
zS#0P2dNd4+xiZPPXL1%0pAaCRKXQ0?xKb?@b5~Fm3arM(fVe3+Dj+d^ud(=Y<?~z;
z>L+gCDLkwux=!>@B?64)@&dM{pRJ8*J!l*HA(g4a>-1-p`9o5_{6<SpJ~4k7^YR}S
z_^2v_{PW=|%OPisP;=@YATk5El=z?V`(0Ob;84~_0N59SA&{BN2TZ+!aw|$}11bX{
zIjG54Nq#RlDI1;|xMY?(#dwAu0<j7<rgqXpPqdZ3GZO5>6x`$>cDxAj?&9)8LuG);
zH$_+_*W6qy4zdwUJf5rYhGMn*B#C3UHK&W6$F<6&OJTstY#fg4tsz^!5%(Pr;2pDa
z_i}xsA~m{@7FYu~6E2dK6zJKsHTeNRH&KC$c{}@;V4e8l;g+Yo^Abe{yQ+;2#jewu
zIbn1Y8N-a3dMWhOPKG!UY=(f&pqzYeAGY|)fyX%$Nw>Igv1ncTWz)k^Eb;d|_HC}D
zY9Uq&3C3y}fT{Jd3=Ju^y>`b`;P<P-JcN629Z+q29~>TBV_1|Zpa?+OgV`<K@mxmE
zXD#p}^{0{!hG9pV?>)*4Vf%{XRbJmC{w%$yxMINsQqX2Fr+2&WBnIU?y-E&`pZDZ*
zqi>xyeIhhLZ>M}XgGJU^LmxMa9p-){rBaiPOh>kbOSgwcQID4Esf@*4VA#vKy?_m!
z+Iqg_elYurP{O@w8~chQ*U|l|nX`Z^$&4Gz#ry7ez)NpQ*ueQuM#Q&&TB@G;Mg<f4
zPV?U~0O-9-;IZs!l%O+vXp$z<-aoX=tKT=~`w>9cbY%e-pSN2JN!s38=e}J`w8ue=
zDolCj0xhWle5wkL^tq|;a9;34KAXR5SR&txJO3tYp2VbewLFg~1n^zu0G~7P{lc^5
zCRcU#FhTazZ(ry~5RJX5tONkiOOb*Esf$g#8DYHnAU*Iv+wue4WJl#-az1!5K*o~q
z5e)1poB<t1t9lp4TmEG<O(YjNNyqK=38E9EnGA9n14~)0dR|H2VyD6uDoQ~<E94hX
zc>ZC&eZ0`LpD-q!bpCNe7AmGy1cau8%q9r<TW}FPzaDV=73=#8j@JVcoa}+qN}iFM
z*Y9|Rw^RCS#PhHBB>`1|7abyNmwfAqpGe|QzPP5Vz_CIVm+vIym;<JfFeLLb6l=vu
zzHx7@bwDl#7L4B)D&!cp6&9bk5M+KC?3i*=wqwvyxS?zZ$7K6`2`khs!3}-E0^us$
zS8NTE?D|lBUDBuEpNsg}vlYovd)})G2yNiRyqo}B#f!t7eU(FH`^zdWtn8Zou#~tc
znIytRjU8B)1F}@$3#pxR#i;3p(1gL|nhUA`Arh<zWLH50mzCM`2Zd*zMp19@D10qq
zM#|wKNVqE4gBkUwpg6*~iRiZ0fFAl(ZopjR8V`x}erz$lAf)*KRGcC6+%S9nDm}TW
zL{$j;+#H7G8Y9O~F+~b<^Tc2`j0zub;M}PG8qgv_M*$*^`%CJ+FDuof^*hzjm1qS#
zl)01(2jU2)6>#Vt<Rgbdb9xvL6aqBy91v*~HEZ?#kC`M*XD2&{h2I8OnLcqQ?+di~
zXyGA58+U0TVGz1<BjGD^yvIc@zA(|V|Ga!Q{~YF|PGkXn4B1lld3dojg6D&2cbNRn
zSqQOW0*Wp82UJiZEi4Y7BD0x0I6esm%uZaTB_?tug4^qen%-M(2Cwf)UC;I5rJCb|
zAj8Je8A9Ex5%jE$9*G5xwBRlaC|rp~B6vE|iT7hDFW(Lh@Q9!-q(B3We#=Y+{EK;j
zi5sri8-YwlHqb(WiYB-$>5lLh>-S>LTlZn5a<WZQ1VOKdt1{3JH18nv`7Tir@mw&h
z7pM>tQ5BZhknOAXqk?I2-Czdb&VK<t%3uW(HE9DesLLj9)b*vLYL<qKIXD=x7=%9W
zqjML+pty;RRb@8@7tnH*v$G%0E(hjgYruxCA`lnYX+7Vd^O5fK#SMgi`<Rg!ZCF7x
z0Dct3MoTwcro~b$7~-<|8`A2~f9KVn5@;!p*|RvoZQCc#v!^^{dna{)>)=A{qY=ix
z^exK7B*_k5yQi1^nNr^N0m+5#;ncN@)JdO4y5V1X7<c|Ob2xdAL>r+}RYPv=Z-tGU
zIyGfsWknV+n6Y1BKFKS$9awRu1K`W0{ZAj6+@yF$&VcLe2jeCVb1Z^t;n<<4+;F=9
zDb?e2)a0}IS64DUJ|&xOF23V?_%VnXo`l&mRZ+O++8J>3ABMUP)5vHTOMKtIj=w#3
zy7akKquyxLL+MA53`c-qirOto3eWC$l#Y*#n|sAHtL_r;XMxKEok?gh%6p`nG3Z0^
z1fQq0EweAj1NFYa%FNNf$CB?P2p@6dWv7u58FT+;^2IY2_o^mCUcq&C9gIZ$y|+na
zgyLW1)8;O;Y(yn<w>RqNEn_Z9MN6h@5$*1}d0*_nXX}&+O^eUaRKwOLLg${lZw>i3
zHn-nF<a2{0kwE9|rd5<_pmEh=DioV-_oiOc>O1-pDJmKBz@xx<T=OFF+F@Df?8e{+
zmTQmnbQSXO_qvpuWO&$@(es#8eorM_wEnb}x?xo4LGIlJ2aQmxU!HGH_@*L7jop|(
z$i6Lny)rjj=({(U!MlJds(ZFv)UQ)e%I+^Yo%~PuIsg79ThCm{Y2;*2{Ic%9b&qV3
zfR|Od_&?ch_rl?%qO=i#a@es^GtbG*m$Z{Ur8`EFgr}X`zikdr@pbLx7AEH~;Ie@V
z>~f-$vaV=av9E+{j`IVDHj{^tH6E<o0-wSCE(toIeT8<Z$4qHQ)pmk3uX*U;i5gaT
zsF(~8e#gxn0>DiUePeT^*2)z7epZ54c-zdKI!<T1g^(I8S}XZY|A!@k205#FaA_0n
z!P!wg_o{c+4BdD`0t^|DKM1J4p!9V&kB*XhhhqMvDK}TOrgAy?4Nd&p_*C{Go-#qV
z4W?23vGxdR2m$uycD^Eu`b4*hZw616{UzV&z!#)JV?LVI?Y1AIC@sN^##sIFEMG+Y
z2w#$Lay&EbPA<Fj`LL(u=lVD5g8NLd7B=&7opa@zYW4PEtcB-*TQwUqCUMToZCtH(
z+=d!j(=BIZzst?+2Yq#DnGBVL2PMZKF?S4D<Bs#lt=l_MA?Lxw^@+g<?oFS984td1
zSszSr4k2=A9-9c_#c%q!K3$jw?NZj*;uv3ss2po7(e9xQNWFegDK5xXbq1nd&$G*J
za72C{`^KKW>ai42!Cv&o_B<OSvPKX6a^+d+*M`<X`<zEb9Kel*8Y0U`ver@LJbOfQ
zB3%4wSTu^UK>!Pgd38a~t1B~@!qL^TK+!j)tWHY^`L`<$GJP#_v<-CEg1IP36ZXmr
z^v)+lC^c^S;wyEn7q8Q&;LGzpbd~ki_V>Oa6Mq>8m!oR}4c~0r<LeY}(Z|o-Oe(gq
z_oTXi9GKU0(*yE6fph=O`n&D!E;?^t&$`;3f`5qOfLjj)oZ9ZJuK&cp7jyO&*lfZ1
ze8Que?p-3c{E0joloAYie>A_I{O7uo#$bf)-D7peiE(auUx&cWFGociH3L@)@0L{d
zZ%$v)B$bL_jnqAPmRKBn_g)LJe`RC({EDTbYplE@%kStm)@y2nF=<)u;1)a0tlpc{
z$~DFBJ(&47F1M@Jv5_*YiD$X(dVRXA!c4>K70d*-LiDE@4X(G_du+=W3D9^%h)z)f
zYiNhE<<?O6#x>R4zLm!)rjXq67r$DqMOwP+i~K#qLjt)+j>0RFe+?u(=|W*;<mNOK
z+1j!!76P-Y&||MES@S0oXL4?xd(<LNm>RYk;|qpE74kAYINd%lfZ9ESBZc(n`>s2g
z_fgW;k6X`)f5!7t;Y-EF$M-Wb1YX*^XSo(llC_q8hMLS|JHILZnbDjgFSQoZ=>~rE
zib(8gQhyg~{IlqOQd|Aq9tx6o$u;sWzA&t|R_>l?^_`Yyvpr++-jYns$?y~DLCX&d
zb?yw+(jC{fcCdHTP0s}5;&VDze|^<zTh#ig`7VNf`r_=s40~M~n%3U-L5PO9%%<0B
zIQsbGR|E2^(?cI#N~u~E*XDX($o#31>@-)rsErbZ%^J`f5X3IeEA!hPS2QuXb;>>U
z=j@ZUA0r=A1B_u`6ipHMYT<<2|Hx?bOe_nKGW!;%bOp~P1E-O#ni7`$`#+BTylc)9
zcbE^4f^AV26^$)DCusR{OAd0O!qE7G@*5s03s)7{<^PG$Zdg20&N}Akz5Rh_>P`&j
z!;V?Cs2{lt4v2_%uWnh`q1T`)CDqN|MQo3c-hX0p=0whZXD;!ad57bG;B|MSruk*-
zjCUb#!_vFe#+G;MMYl4wrW_2vC#{WOoLzQY{l6>v^G#gYx0zBuP#DW&%1T@tQ$w@a
zu|vJ#N;#k9ZWDa?cS5W$&AbbEg7?~blSa}&ueX+>fl2W{m#aopr)uMcdDBX`Mg@8q
zdqt+EG^Tsr(cZXUSCSWSLl`lm-w~dw4XaZVMFU}oNwaCYpc1LXAIIt%cT+w(B=1D6
zFM8p4u)}hnv}61UAD#1~{%%0Hdz`APKc-kKSstZ%X5ss2BE{L~rN=rHq2RCo=%j`4
zkcv__rko^`%L?40EkfJhH(i>Z%r2cqTjLxqa`<O9OO2ThWp7pA!~rMqKFg}wGXh&)
zaWCx7xbnp2STa!Ja^$#hxjqnvt@BCLoT_IKd_)jTL1!0{vozN<1%CUw2cpL7XdVb=
zHA|TaZa7?JGh;kl4fl0ZjrS@U>94x`ni2-fN$cTYPVB`Fdh|z&@xaKR`P6QXtly1k
zNDeEehpTv+NZJ&Ozi7MortdO~1_ku9i-WVOKj=$0%cjR9yS&WFQ9~2<qjj`H<{`U0
zy${_z1<=&wsyA^atk6E?y~0%9D&<HOyY&k;J=^bZseMHinOF#)&QfB(G$VpNX9)2M
z^YsiLF4|xUbJ0kIJ^rfcwK)9xXT@MqeGc9ar1rEw39b(M&2Vw_kT^K9k6Q6uVa1Y%
zyF*_Lej{`Yw(OH~6rk9Ei-;nnHtjp(wH~YfOd3C2x)|mLb)92W(?(h;LE61i#sb^|
z(n3u-)~lS$uXGe&l?`=X6WlPCILmCb8%1eJ-EOJ*0tkmey_BP(*iy_*Ls?&V={*L>
zIiGLOgJ;DH$rgJQOO!7y>O_x)b-Lqv2JV;VQM;Kd>m9H4iYhAFaacBfwob+5+?&g)
zl}A1>A5#HX&e2k6>4aglWAKpE_t{q-vFO&dL+&raJr{<GIi)2r0(M23rw@FDf%q+E
zTUIJ68C<RT_axblXFD!K8OclD-?q0sjxQh)qUdbN!!S|&+NrXa3?!pBo@N@>p4q2{
z&(V~k`|+`xw_0}bZ?lqmK@a0bT%xGw%`!Jv-!p()6FHQ^Kw^RvHpS@&ZVYB5%q!rt
zqRkJMy9%22XWisMH!U<K$Y;aR-@TEu>t9b}2>q*O3?m1WG^<(vr^&sXqfeIs$*u_b
zsiJr=t^S*ajB?$Ok;44@#nrPvbhW8*$2<^eV5us{w&AqoY+GAbM8gR|>M}DwT1#V-
zf7mLhL_;<b0^PrzKbZ6RtY_L7)Q|<$%lJ59`1MoeNeAd<{tL?`x3HKBIH~R8Q@Xmw
z<eRSK08vFD!`KCEtf}LZnLtgBxPFurc67h759FI)qauVJG-~fAw`r)z1l+RY^TP+H
z&y`b2Ec!6;^=X@}wCw5B2#5Zb1C>*W9eR}fp*disp|!TKn{F1y^m3n^hF%-Sw8iDR
zjFszSNFve1*Bwf2rBn#jj$9E;ie8+Ds$K{74rQ<HM!|@6AMEvG|M%AjDQvzAknb4|
zj0NvThgKKz4y>99xP0vuWQn10=u98%>q*O>t;zZ-V}qZ9T9pANaL*RjmFC&jsA&?n
z@3qQPqkiSayx_F?2{ZPUA^v8u_iPa2)9&?l!!CZhz#gleP5cDQ?Rn?pyF?AgZ3j;k
zt7{^`>#tdG6(U&tub&5Lk&u>El=T9^IX}BcGP!Lw*KGfDQD%wS7n{8=Bo?lmI$%8D
zOeX@mFW9R+Q#AF4H9b(EKDg@B79@eg$T9ddPo4jTm_~i48j9<uj}U9N)1n6kOg@}G
zYZh{1CBuE_2ih!Fllz`*t+9U)nn<7ZhpNV>+SrgS_?Ua}dh5l{03qKL9#I_>?P^)5
zt#RMy{5Ar{%FUsgfZaWhts|NBmWNk;q#=Z^wlThRnQvJt>$?6Hg7lJNl7L1>t)Y|@
z)B=<LI#EIIZ=L!R<VMMw&^uzcn`5kEuzm_BnsawJ)b)(V$ThT3?C=l_5;!;hScPdT
zqB#A=<3^P)@#Qm5?@`H<L<?vjU13(BKt-HsVvJJxE_A>Eh1j@<P=v~y+wo*L3BF_M
z6fCqv`6b;A$WDvQ;K^hg9_D@E7i-S-+|a~eO0a6^i|Lh|Qx6tuP*lx2NyA-hI;Gx#
ztKEu)e|eAZzQ3iL*NfPvbjVk2f32wttG?))N$9F_HT#824C?tGF;j(2i6?804V?O&
zqqL5zTzZL}*F4uy`G;0sua^6CshdmFxVd_V`^KIxJrx<^`-C;$`?YcJRiLW`S~8do
ztF$<nZE_XjozuH|C_1OqZrk|tUAKE?;JidE$AE25b%x`rB3b$G1OK4kOEn!>oH5qx
z^knENBrAcqTk>hY(Vrib@Bs77hhs*h+EGH)4e5s`QwQ>y(e8J)7mkkV>oQkb<*CCJ
zY`bwG`8dNlwCcC(Aa!hzNf8XG*cRE50=&f`$k7R|+Rn}#{QASY60l=kl3gF{uBTW3
z@~#xQHW-;yYUG@=KZg{~c2JP>Zk$P!Te)6*=Aw8Wx|J>Rsj6UXg*F42^5pfp8~QxA
zC@i8`XKxfepyrQuV7+F^pXAdQ2jEXGc^47(PDTUhs&h5kX(_mX%Am2(yTjF${C5-g
zDZs&8yPemKZ?=PH{{u6czWp_C+_z3LqVP!Nju)qOpA@&JHq$AW*t@l3t8^6R@ng!|
zbs3YW@*nE3CgmbSlK2mF7|QEh)nNLW#PXk>sq9O2os6$}DKjUE%r$X)vGpZ#k}(#5
zTDh#(Erj^oHIZj?{M?jP<L28}mlPgPM(I)z4eXr+Sh+O2bmn#-IVbf$?;0A1=hh?E
zTc1!wvGeJFPb@pmQP}>3U#*Vx<6YB@<eNX@x3mDD9kMgsk0{sXIgyv62*6n>Gd}=l
j{?CE`LnA|O)_WSQM_RXOYhzU@cfpP8#yan{oMQe5hj2XW
literal 0
HcmV?d00001
diff --git a/docs/conf.py b/docs/conf.py
index 55ae990..d53f0a3 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,17 +1,10 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
+# Configuration file for the Sphinx documentation builder.
#
-# CSEntry documentation build configuration file, created by
-# sphinx-quickstart on Sun Feb 4 20:26:41 2018.
-#
-# 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.
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
# 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
@@ -23,11 +16,22 @@ import sys
sys.path.insert(0, os.path.abspath(".."))
-# -- General configuration ------------------------------------------------
+# -- Project information -----------------------------------------------------
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
+project = "CSEntry"
+copyright = "2020, European Spallation Source ERIC"
+author = "Benjamin Bertrand"
+
+try:
+ # CI_COMMIT_REF_NAME is defined by GitLab Runner
+ # The branch or tag name for which project is built
+ release = os.environ["CI_COMMIT_REF_NAME"]
+except KeyError:
+ # dev mode
+ release = os.popen("git describe").read().strip()
+
+
+# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -44,68 +48,21 @@ 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 master toctree document.
-master_doc = "index"
-
-# General information about the project.
-project = "CSEntry"
-copyright = "2018, Benjamin Bertrand"
-author = "Benjamin Bertrand"
-
-# 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.
-try:
- # CI_COMMIT_TAG is defined by GitLab Runner when building tags
- version = os.environ["CI_COMMIT_TAG"]
-except KeyError:
- # dev mode
- version = os.popen("git describe").read().strip()
-# The full version, including alpha/beta/rc tags.
-release = version
-
-# 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
-
# 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
+# 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"
-
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = False
-
-# -- Options for HTML output ----------------------------------------------
+# -- 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 = "alabaster"
-
-# 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 = "sphinx_rtd_theme"
+html_logo = "_static/CS_entry_v02_white_512.png"
html_theme_options = {
- "logo": "CS_entry_v02_blue.svg",
- "description": "Control System Entry",
- "fixed_sidebar": True,
+ "logo_only": True,
}
# Add any paths that contain custom static files (such as style sheets) here,
@@ -113,76 +70,6 @@ html_theme_options = {
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
-# Custom sidebar templates, must be a dictionary that maps document names
-# to template names.
-#
-# This is required for the alabaster theme
-# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
-html_sidebars = {
- "**": [
- "about.html",
- "navigation.html",
- "relations.html", # needs 'show_related': True theme option to display
- "searchbox.html",
- ]
-}
-
-
-# -- Options for HTMLHelp output ------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = "CSEntrydoc"
-
-
-# -- 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, "CSEntry.tex", "CSEntry Documentation", "Benjamin Bertrand", "manual")
-]
-
-
-# -- 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, "csentry", "CSEntry Documentation", [author], 1)]
-
-
-# -- 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,
- "CSEntry",
- "CSEntry Documentation",
- author,
- "CSEntry",
- "One line description of project.",
- "Miscellaneous",
- )
-]
-
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
diff --git a/docs/index.rst b/docs/index.rst
index b2f3223..becba50 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -21,7 +21,7 @@ Control System Entry
.. image:: https://gitlab.esss.lu.se/ics-infrastructure/csentry/badges/master/coverage.svg
:target: https://gitlab.esss.lu.se/ics-infrastructure/csentry
-Release |version|.
+Release |release|.
Control System Entry is a web application that facilitates the tracking of physical items
and network devices.
diff --git a/requirements-dev.txt b/requirements-dev.txt
index 7c3da67..d045fd5 100644
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
@@ -1,4 +1,5 @@
sphinx
+sphinx_rtd_theme
sphinxcontrib-httpdomain
coverage
factory_boy
--
GitLab