From 04ef56dd7ddb80cbd4c3e64ba6e98b32817bf343 Mon Sep 17 00:00:00 2001 From: Marco Heinemann Date: Tue, 15 Jul 2025 13:57:22 +0200 Subject: [PATCH 1/3] =?UTF-8?q?=F0=9F=93=9A=20Change=20logo=20/=20fmt=20do?= =?UTF-8?q?cs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/source/components/configuration.rst | 26 ++++++++++++------------ docs/source/components/oneline.rst | 12 +++++------ 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/source/components/configuration.rst b/docs/source/components/configuration.rst index ded60a3..44d21b9 100644 --- a/docs/source/components/configuration.rst +++ b/docs/source/components/configuration.rst @@ -41,7 +41,7 @@ Set this option to ``False``, if the local link between a need to the local sour Default: **True** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -61,7 +61,7 @@ Set the desired custom field name for the local link to the source code. Default: **local-url** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -84,7 +84,7 @@ The remote means where the source code is hosted such as GitHub. Default: **True** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -104,7 +104,7 @@ Set the desired custom field name for the remote link to the source code. Default: **remote-url** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -126,7 +126,7 @@ src_trace_projects This option contains multiple sets of project-specific options. The project name is defined as the key in a dictionary and its corresponding value is a dictionary containing the options specific to that project. -.. tabs:: +.. tabs:: .. code-tab:: python @@ -149,7 +149,7 @@ Default: **cpp** .. note:: Currently, only C/C++ is supported -.. tabs:: +.. tabs:: .. code-tab:: python @@ -171,7 +171,7 @@ The relative path from the ``conf.py`` or ``.toml`` file to the source code's ro Default: **./** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -194,7 +194,7 @@ The pattern to access the source code to the remote repositories such as GitHub. Default: **Not set** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -234,7 +234,7 @@ The option is a list of glob patterns to exclude the files which are not require Default: **[]** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -256,7 +256,7 @@ The option is a list of glob patterns to include the files which are required to Default: **[]** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -281,7 +281,7 @@ The option to respect the .gitignore file. Default: **True** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -307,7 +307,7 @@ This option enables users to simply define a customized one-line-pattern comment Default: -.. tabs:: +.. tabs:: .. code-tab:: python @@ -344,7 +344,7 @@ Default: With the default, the following one-line comment will be extracted by ``CodeLinks`` and it is equivalent to the following RST -.. tabs:: +.. tabs:: .. code-tab:: c diff --git a/docs/source/components/oneline.rst b/docs/source/components/oneline.rst index 1867d78..ab96d15 100644 --- a/docs/source/components/oneline.rst +++ b/docs/source/components/oneline.rst @@ -97,7 +97,7 @@ For example, with the following **needs_fields** configuration: the online line comment shall be defined as the following -.. tabs:: +.. tabs:: .. code-tab:: c @@ -131,7 +131,7 @@ For example, with the following needs_fields definition, the following need definition in source code is equivalent to RST shown below: -.. tabs:: +.. tabs:: .. code-tab:: c @@ -152,7 +152,7 @@ For example, with the mentioned :ref:`needs_fields definition ` field ``title`` is the first element is the list, so the string of the title must be the first field in the one-line comment -.. tabs:: +.. tabs:: .. code-tab:: c @@ -176,7 +176,7 @@ a leading character ``\`` must be used to escape them. For example, with the mentioned :ref:`needs_fields definition `, ``,`` is escaped with ``\`` and is not considered as a separator. -.. tabs:: +.. tabs:: .. code-tab:: c @@ -189,7 +189,7 @@ For example, with the mentioned :ref:`needs_fields definition `, The other example shows the angular brackets ``[`` and ``]`` and comma being escaped: -.. tabs:: +.. tabs:: .. code-tab:: c @@ -203,7 +203,7 @@ The other example shows the angular brackets ``[`` and ``]`` and comma being esc To have a backslash ``\`` as a literal in the value, use ``\\`` as shown in the following: -.. tabs:: +.. tabs:: .. code-tab:: c From a139f64eb1fc834fa50c210ce81ab71c6896cd43 Mon Sep 17 00:00:00 2001 From: Marco Heinemann Date: Tue, 15 Jul 2025 14:38:08 +0200 Subject: [PATCH 2/3] Exchanged logo --- docs/conf.py | 4 +- docs/source/_static/favicon.ico | Bin 15406 -> 15406 bytes .../_static/sphinx-codelinks-logo_dark.svg | 120 ++++++++--------- .../_static/sphinx-codelinks-logo_light.svg | 123 ++++++++---------- 4 files changed, 110 insertions(+), 137 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index eca06af..b155544 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -59,8 +59,8 @@ "source_repository": "https://github.com/useblocks/sphinx-codelinks", "source_branch": "main", "source_directory": "docs/source/", - "light_logo": "sphinx-codelinks-logo_dark.svg", - "dark_logo": "sphinx-codelinks-logo_light.svg", + "light_logo": "sphinx-codelinks-logo_light.svg", + "dark_logo": "sphinx-codelinks-logo_dark.svg", } html_css_files = ["furo.css"] diff --git a/docs/source/_static/favicon.ico b/docs/source/_static/favicon.ico index 39dce04727130a2e341bd5eefb5fa22edff54cb7..38d9b22bf2bd080ca4acd844cce7257afd72a3ba 100644 GIT binary patch literal 15406 zcmeHO378bc74F@gontR{m%Yzf_F(paUG_d^kwgujpdpArgh-5pfS>{@NE8XtpvHi~ zXjG7BkVAwI@jw)Ua-RXj3k1x9fYC%hgQ9W>RNh~`)zdTGJ=e}G$@kIUS5sa6Ue$Z` z>ecn$8%c_gqNKz`iE_I%#w1Dgk|f#fa@mn2Nzc%?s;YK)i6m`Jl_Uq@P!*~nf2YjL zV|7ZBZ9S!vlur3bz#&}J!DDTr@@YwmVSy#ou{KkBQ(ezK;~thZ;bx_+(&f*vr2hSs zvKm*eYx`FHE$=szSUR}u{^~;}nc{h!yn83H z$}O)L)OYW5+6}{4#p{b%>xE;i{FUce>C&fJ)%Mqz^VC21JIdyqZia283>n0V=lzj2 zeepi4+P0FvmpuC?)_VRZD}QYfFPpRMhV?~XN|()Jg^xd^;MKKlXBnezRLTO+D9@QZ zo>lEwrQnyo@H8u$GgB!W)r(HgWyN!6v5GY>P@miQJIcNGtYHnG?B?Z^p@R+EF=yt> zaw7g)&wb2#Zdk#~6|0wUnU=jgpQZoe2E+PlzH0YxWSL`s$#J8)q%-IDM_7DAlTKZ& z4xpXx3;xVX{xVy^ui3YrWsV!Alx13|Yh9c)mA?6)$QK#b%))_mcK9sON`T3ZM_o0+l5HCk4od{8) zw$LWpmWYPlV<{x~c9Q7@eYyH0d!IPewsi-|m}sdVO96d97Dl=r`ei*%JP=L(&@N%y z*m<;tjBJ~TI?*=&gy^3)qTl7RKCIyP)0q8%sVvf(^Q4_=S>aFTe~t0v~3@I!^6ISH4ij0 z$Bfj_$iMGy4r}@L5Q|F6(7?U5E$f_*J(~8r`Xf6yjbhchC)!QEray;)zXWG%fb@OP zZXd(46@TS4s`svC5{xT!gmb@a?`n{}o7~5b|%HV5*k_qTLi9Y%)66Zlx7T=Kz{?y;_9xVL`a~Brh)WQ;) zojg^nTFhxQ{_}0F=i)o^q`rOmSq?nlT&9MZx@HB{f6uYWzT*~7-+88uMW^Lz+N}L> zBZrs0G+zVrY%7>D)?p#%#4E1Q(CEJK2~NNM=uRd@#%bWe&{Wqk(b|UdGGv_l>xr87 zv&P@dVXbtYGv^j+;Oe%5dXI=~4IW`h42qxRtNSZ+Ps}Uc#|y_b--T`fE^tL|Eh-I~ zzL050@?h!X-XYdeK5XFsI-6uXk8Pbb=d=$e6BlN8ZojxYzhc5BC-A{%7

9Ka12BvM3-<9Yr>_7e3p4BcH54}!9L+AjPkI#9BbGUVR zAoL?`$*lRyeY}qa4^P+7Pa82zmJjKmtwbvycUqur9zfo*i+IY+*#LK50YcCMKZJ)_BW$N;8 zbUDdkFYyr2SOmy3?w>>hv~(XU-3xCbS^SOgNFKIx0k*F*-e`ljMQvI}5>=vc=@Ale z&`TAi8z}`~Cn0S9MA2_H=~90Z>!T#!&6Kyv@`lXAo(>aDvKd*Qka>`Di68Lf&yzuQ zN0W}Nqx3Z;LmNQHbb3%0eyz2`WP+^us77J_xj7Y`kUgGb8(>H~RQ_!B|pQN;U+ z@auC&c^CEJL$UmdxR0bn9wqA<;@_|RDKfSzOYHk2mfZg;?mMwL$~CqdMGj;`iEnXo zT;O-P{BjnWGc$Mv&(I?i`IP*ZJ?@ZoA8q01{g!VIvLf=E;C!p_tUfam|Bl5^$+&bs zsK@=RQO~C!cP!Ys(tdWm zA+Avy`rk1ImYI}jZ}Pw2u=SQa_qcM_hObKRyf519()%*zJl!UreaUW=H*J#Qs}nfE z=hj^$d#`p{P1{j%+^^$2E8odmP99{5q}Lj}c9~f0B@Fj^i~;VCCG#I+QSqsU_(tvM ze}``&uzMETNgXznHJ_00bMQ50PaJ2+k0~*ORc>6N=uqX>SD8OPNqv4j^~848KRow( z@r})jOd(gt^K%UO=laHds zy;HFPVJ;-~>!*(!z&zBY>zqCSx2Yan0 zzgS7|mka*E6MVgDxca^8zyYk`)3+7;iZ_-pi`~_h8rPJZ8S=4#%{qVj6jt-zI#%=k zdY&4{UM=`Xjd*D*6Ll*t$G%L^=2F+e6Pk*-MJ&K0` zw?q2vp>wda%KRVYYq+p~B3F2)clCF@cLle7FVMpY3;$%#%bGBj!Oo1>3Xy8seGA|V zzDTS|0_K_H%pv@hz;F8U1G2>})!=JmCPFh7SjVFh(%cekV%WdH57r>~3gE}{#6#Iy zSjw6{e@_{&ngg4-Kfx0>!qXS+p$nnZtJunF*SdJ_D6>C!FT-5dr9o%WN{THKI@I{t zUS=!pp^qCzp4GfXr{^)m-EjRO{dZ8@P!#z#)Hv$*Zjaorocj=Sm24R26&jsU)7E>( zISlb)VjlO}wVGM-jD1Wgg9a+TQ}|@EZX08K_vwT&fStbZ(HS%^+nn`C|RyeK7FBs_TiqB3FMG?}%j#-5t}l7K48^ z?Qp%r&lC>+Ge+N}d+tSyg*qmt<#ZdXr8}886T9UftXJ;NLjHAa+uU&BBZZwT~!%waKhI6tLP?5Y|!T=UnPJjy738u57G3;UQi zA7k2x;mRBaKKz#6+U^V(;&bZ>LeK{4lI z4&Yu8SEr2u^`xOKgZI$H_nMNk_yw1P`#;x%BN2OVx>45V*#<^%LTM zyD{9g_WQz#v?cKvdchO7>vkvKfWdwVeN)bT&^Oo}qU8Tz7}e2!=l0v*1!6zfw$a{4 zvg_vmc8U^n+H&%MSGz83cw)^(pNr?s_Ns4My4*K8i~JX@#6S50{Fk*6ZaS@t&0imo z=K%4Pb?azD`6KSGaueO@2@k2qTgzz<=NaN_X~MT_?$_==q8I@G{72e$T>XYj5sQWY zd?4xne?!KPp!ns)AN)|kg^eyU-rsmE?mrTKNb-UG-}>*ONd9=zs1M|mjJb%ucGoz1 z8)KPA#3xDQuXcN=5Af;zPxk@-Yx+-x#(yn3LcV$HGQy$%%!M`HCxCg%#|7~N&#LI3UH25CAmu0xPra|s zTl)6VRQkyfn!f3ww2`GOugJ1|bMIdATsadKlaB5rM^X6@AEjm&Qd(|tSa^8{@<(iS z_3y2viTk%3LPO6ca+X%=Y%uD-wsXfQ`{rpnS@z$ES+~>3IkUqeqjAy@S(c9#rAr>7 zif5JvMEUZ^kza*DbcD_y&)_L4xbL12vYdnIRQcRfRJ&%?5ER_o6-1V8X4zQVkJ1KX zXum8Uec^t_4NL>Le==AyVEZEA3*b-q?`o{^_dbK4r92bQ7SIu>IM7qd-kdQP0590NuY?uUl%9$WpI^OYw|g9NK=a~ZnImJ0_4w@@ zsIC8aRG9MfLCTywB|`oBF+jBKul27VD0})XQRt3+{MFWfjB;0u6>0Zg+uos!Tk^5ie35hUYf$a zpv=$jY77E%XL}Ouf9Brs@jK)!i*Ai2k^DUar>K7GI;=I13F3Fv|G}@7E4#^qb`x*# zenS2G>&R81-A@V5Gf?hx9m@~Du{HjfaucNm&G*Rd2xechKIzM34%jybGMbtxf8HG1 zAg|+2W&PP`&Q!k8O+0S016t31PZcYkBwj-|%0H3sU+uWG?R+nlEqjb2JqKn7{=5cV zx$Ejz?=B~9P`8j-BOZw_`PlBdAIA&Iz>%~dq^HL&Lscq&k3k8vf};gxpJELyin%k z78AM0Z~d_O$6b^&b0&$@Otbi7{gD5+V`%?lw*Ons9H8N?Z6t=7#hp1zUt|6AMeyf+ zC7n;q;_tb7hMJGGg}U7~w}H8%zZB&<=GVWVUfKpb&fCxT zoHNpgpvq@CLKHqDAuWRqb~?Xt1pQ>Uf%6-xUA(W&ZK4ZyYyf(Jc%Pr?gU*fMFc(~q Q+rpueOJ0*6Fv|n~0Nzy>!vFvP diff --git a/docs/source/_static/sphinx-codelinks-logo_dark.svg b/docs/source/_static/sphinx-codelinks-logo_dark.svg index 0fcf76e..7e268bc 100644 --- a/docs/source/_static/sphinx-codelinks-logo_dark.svg +++ b/docs/source/_static/sphinx-codelinks-logo_dark.svg @@ -1,78 +1,66 @@ - - + + inkscape:current-layer="Ebene_1" /> + + + + # + CodeLinks + diff --git a/docs/source/_static/sphinx-codelinks-logo_light.svg b/docs/source/_static/sphinx-codelinks-logo_light.svg index e763e03..7038750 100644 --- a/docs/source/_static/sphinx-codelinks-logo_light.svg +++ b/docs/source/_static/sphinx-codelinks-logo_light.svg @@ -1,81 +1,66 @@ - - + + inkscape:current-layer="Ebene_1" /> + + + + # + CodeLinks + From 754bb85e7a17197d7799c32525993f46ac6b4899 Mon Sep 17 00:00:00 2001 From: Marco Heinemann Date: Tue, 15 Jul 2025 14:42:35 +0200 Subject: [PATCH 3/3] Rm trailing whitespaces --- docs/source/components/configuration.rst | 26 ++++++++++++------------ docs/source/components/oneline.rst | 12 +++++------ 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/source/components/configuration.rst b/docs/source/components/configuration.rst index 44d21b9..ded60a3 100644 --- a/docs/source/components/configuration.rst +++ b/docs/source/components/configuration.rst @@ -41,7 +41,7 @@ Set this option to ``False``, if the local link between a need to the local sour Default: **True** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -61,7 +61,7 @@ Set the desired custom field name for the local link to the source code. Default: **local-url** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -84,7 +84,7 @@ The remote means where the source code is hosted such as GitHub. Default: **True** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -104,7 +104,7 @@ Set the desired custom field name for the remote link to the source code. Default: **remote-url** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -126,7 +126,7 @@ src_trace_projects This option contains multiple sets of project-specific options. The project name is defined as the key in a dictionary and its corresponding value is a dictionary containing the options specific to that project. -.. tabs:: +.. tabs:: .. code-tab:: python @@ -149,7 +149,7 @@ Default: **cpp** .. note:: Currently, only C/C++ is supported -.. tabs:: +.. tabs:: .. code-tab:: python @@ -171,7 +171,7 @@ The relative path from the ``conf.py`` or ``.toml`` file to the source code's ro Default: **./** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -194,7 +194,7 @@ The pattern to access the source code to the remote repositories such as GitHub. Default: **Not set** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -234,7 +234,7 @@ The option is a list of glob patterns to exclude the files which are not require Default: **[]** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -256,7 +256,7 @@ The option is a list of glob patterns to include the files which are required to Default: **[]** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -281,7 +281,7 @@ The option to respect the .gitignore file. Default: **True** -.. tabs:: +.. tabs:: .. code-tab:: python @@ -307,7 +307,7 @@ This option enables users to simply define a customized one-line-pattern comment Default: -.. tabs:: +.. tabs:: .. code-tab:: python @@ -344,7 +344,7 @@ Default: With the default, the following one-line comment will be extracted by ``CodeLinks`` and it is equivalent to the following RST -.. tabs:: +.. tabs:: .. code-tab:: c diff --git a/docs/source/components/oneline.rst b/docs/source/components/oneline.rst index ab96d15..1867d78 100644 --- a/docs/source/components/oneline.rst +++ b/docs/source/components/oneline.rst @@ -97,7 +97,7 @@ For example, with the following **needs_fields** configuration: the online line comment shall be defined as the following -.. tabs:: +.. tabs:: .. code-tab:: c @@ -131,7 +131,7 @@ For example, with the following needs_fields definition, the following need definition in source code is equivalent to RST shown below: -.. tabs:: +.. tabs:: .. code-tab:: c @@ -152,7 +152,7 @@ For example, with the mentioned :ref:`needs_fields definition ` field ``title`` is the first element is the list, so the string of the title must be the first field in the one-line comment -.. tabs:: +.. tabs:: .. code-tab:: c @@ -176,7 +176,7 @@ a leading character ``\`` must be used to escape them. For example, with the mentioned :ref:`needs_fields definition `, ``,`` is escaped with ``\`` and is not considered as a separator. -.. tabs:: +.. tabs:: .. code-tab:: c @@ -189,7 +189,7 @@ For example, with the mentioned :ref:`needs_fields definition `, The other example shows the angular brackets ``[`` and ``]`` and comma being escaped: -.. tabs:: +.. tabs:: .. code-tab:: c @@ -203,7 +203,7 @@ The other example shows the angular brackets ``[`` and ``]`` and comma being esc To have a backslash ``\`` as a literal in the value, use ``\\`` as shown in the following: -.. tabs:: +.. tabs:: .. code-tab:: c