Bug#915583: Bug#1059730: debian-policy: switch to new Debian-conform html theme for Sphinx/reST

[Stéphane Blondon]

> Holger Wansing  wrote (Sun, 31 Dec 2023 10:02:29 +0100):
> They look really good indeed.
> Especially how the menu/sidebar is shown/not shown on small screens
> (smartphones) is fine, that was an open point in my proposal :-)

Thanks you but it's more a good work by readthedoc theme than me. ^^


> BTW: I think it would be good to have the 'Next'/'Previous' buttons
> at the top additionally to those at the bottom.
> The theme supports this via a config option. Simply set
>
> html_theme_options = {
> # To get previous/next buttons at the top and the bottom:
> 'prev_next_buttons_location': 'both'
> }
>
> in conf.py.in.

It's a good idea.
The interface is visible in the screenshot attached to this message.


-- 
Stéphane

Bug#915583: Bug#1059730: debian-policy: switch to new Debian-conform html theme for Sphinx/reST

[Holger Wansing]

[ Hrrr, I sent this to the wrong bug #1059730; so resending to the correct 
one #915583 for completeness ]


Holger Wansing  wrote (Sun, 31 Dec 2023 10:02:29 +0100):
> Hi Sean and Stéphane,
> 
> Am 30. Dezember 2023 23:43:17 MEZ schrieb Sean Whitton 
> :
> >Possibly some of your changes could be applied on top of that?
[...]
> @Stéphane: 
> The URL is 404 now, could you provide the draft again somewhere?
> ()

Thanks, your files are back online.
They look really good indeed. 
Especially how the menu/sidebar is shown/not shown on small screens 
(smartphones) is fine, that was an open point in my proposal :-)

BTW: I think it would be good to have the 'Next'/'Previous' buttons
at the top additionally to those at the bottom.
The theme supports this via a config option. Simply set

html_theme_options = {
# To get previous/next buttons at the top and the bottom:
'prev_next_buttons_location': 'both'
}

in conf.py.in.


Holger



-- 
Holger Wansing 
PGP-Fingerprint: 496A C6E8 1442 4B34 8508  3529 59F1 87CA 156E B076

Bug#1059730: debian-policy: switch to new Debian-conform html theme for Sphinx/reST

[Holger Wansing]

Hi,

Holger Wansing  wrote (Sun, 31 Dec 2023 10:02:29 +0100):
> Hi Sean and Stéphane,
> 
> Am 30. Dezember 2023 23:43:17 MEZ schrieb Sean Whitton 
> :
> >Possibly some of your changes could be applied on top of that?
[...]
> @Stéphane: 
> The URL is 404 now, could you provide the draft again somewhere?
> ()

Thanks, your files are back online.
They look really good indeed. 
Especially how the menu/sidebar is shown/not shown on small screens 
(smartphones) is fine, that was an open point in my proposal :-)

BTW: I think it would be good to have the 'Next'/'Previous' buttons
at the top additionally to those at the bottom.
The theme supports this via a config option. Simply set

html_theme_options = {
# To get previous/next buttons at the top and the bottom:
'prev_next_buttons_location': 'both'
}

in conf.py.in.


Holger



-- 
Holger Wansing 
PGP-Fingerprint: 496A C6E8 1442 4B34 8508  3529 59F1 87CA 156E B076

Bug#1059730: debian-policy: switch to new Debian-conform html theme for Sphinx/reST

[Holger Wansing]

Hi Sean and Stéphane,

Am 30. Dezember 2023 23:43:17 MEZ schrieb Sean Whitton 
:
>Hello,
>
>On Sat 30 Dec 2023 at 11:11pm +01, Holger Wansing wrote:
>
>> Source: debian-policy
>> Tags: patch
>>
>> Debian Policy has been migrated to restructedText / Sphinx.
>> However, the current html theme is not conform with the look of the Debian 
>> website.
>>
>> Bug #1053549 (https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1053549)
>> requests to create a new theme for Sphinx-based documents "to match our docs
>> appearance with the Debian website colours etc."
>>
>> I have worked on this and a patch is attached, to fulfill this goal.
>>
>> An preview how the Debian Policy would look like with this theme can be 
>> found at
>> https://people.debian.org/~holgerw/sphinx-theme-for-debian/alabaster/debian-policy-manual/
>>
>> Please consider to apply this proposal.
>
>We're actually in the middle of applying someone else's proposal, here: 
>#915583.
>
>Possibly some of your changes could be applied on top of that?

Yes, of course.
I wasn't aware of other work on this front.
And Stéphane is for sure the right guy for CSS/theme topics, he has much
experience there, other than me. 
I just wanted to push things forward somehow.

So, let's see how it goes and if things remain from this proposal


@Stéphane: 
The URL is 404 now, could you provide the draft again somewhere?
()

BTW: I missed the MR you filed for my release-notes's draft regarding CSS, 
sorry. 
I will follow up there shortly.


Greetings
Holger

-- 
Sent from /e/ OS on Fairphone3

Bug#1059730: debian-policy: switch to new Debian-conform html theme for Sphinx/reST

[Sean Whitton]

Hello,

On Sat 30 Dec 2023 at 11:11pm +01, Holger Wansing wrote:

> Source: debian-policy
> Tags: patch
>
> Debian Policy has been migrated to restructedText / Sphinx.
> However, the current html theme is not conform with the look of the Debian 
> website.
>
> Bug #1053549 (https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1053549)
> requests to create a new theme for Sphinx-based documents "to match our docs
> appearance with the Debian website colours etc."
>
> I have worked on this and a patch is attached, to fulfill this goal.
>
> An preview how the Debian Policy would look like with this theme can be found 
> at
> https://people.debian.org/~holgerw/sphinx-theme-for-debian/alabaster/debian-policy-manual/
>
> Please consider to apply this proposal.

We're actually in the middle of applying someone else's proposal, here: #915583.

Possibly some of your changes could be applied on top of that?

-- 
Sean Whitton


signature.asc
Description: PGP signature

Bug#1059730: debian-policy: switch to new Debian-conform html theme for Sphinx/reST

[Holger Wansing]

Source: debian-policy
Tags: patch

Debian Policy has been migrated to restructedText / Sphinx.
However, the current html theme is not conform with the look of the Debian 
website.

Bug #1053549 (https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1053549)
requests to create a new theme for Sphinx-based documents "to match our docs 
appearance with the Debian website colours etc."

I have worked on this and a patch is attached, to fulfill this goal.

An preview how the Debian Policy would look like with this theme can be found at
https://people.debian.org/~holgerw/sphinx-theme-for-debian/alabaster/debian-policy-manual/

Please consider to apply this proposal.


BTW:
I have also requested to switch the developers-reference to the same
theme (https://salsa.debian.org/debian/developers-reference/-/merge_requests/47)
and the new release-notes for trixie are already using it
(https://www.debian.org/releases/testing/release-notes/index.en.html).


So long
Holger


-- 
Holger Wansing 
PGP-Finterprint: 496A C6E8 1442 4B34 8508  3529 59F1 87CA 156E B076
>From 1193ec1df212565fc5344a9a4bf31b65275cfc5b Mon Sep 17 00:00:00 2001
From: Holger Wansing 
Date: Sat, 30 Dec 2023 22:49:20 +0100
Subject: [PATCH] Switch to new theme for sphinx-based documentation

---
 policy/_static/openlogo-policy-manual.png | Bin 0 -> 15237 bytes
 policy/_static/openlogo-policy-manual.xcf | Bin 0 -> 7904 bytes
 policy/conf.py.in |  13 ++---
 3 files changed, 10 insertions(+), 3 deletions(-)
 create mode 100644 policy/_static/openlogo-policy-manual.png
 create mode 100644 policy/_static/openlogo-policy-manual.xcf

diff --git a/policy/_static/openlogo-policy-manual.png b/policy/_static/openlogo-policy-manual.png
new file mode 100644
index ..bd449f163feefe9e3c0b0f473acfe11591e275f5
GIT binary patch
literal 15237
zcmeHtWmKF?)^6kO8nhdCZ`|FT5L_E*oThOIPJrML0t9!L1PBCo3+@sm5G+U_K#+u7
zl5=L}%>Cwm-<`GY{WrZ}T(KYVWFk>59?TRKmfezytsQI4a8Wx(|PCAKs03ERJjMfGGEU1
zZPJbh-^YDh4fOBY$V=%of72y-s(9lM`l7$X`}F>8kc8XDTAPwrzQ7N#zpC`1N#h@eD5N`>;Y{FYZZMZPv}!Eo?l2
zH%vNpeGjgbce6hsk`taT-1E6^A1%69BtzpS?~;4pK5f0bA)@%SY^hUGR{EZp`R8o;
zTAk6s_N39xS)D}+;n<$v5K%CW-Obtc&>rVck?WJl>oT#S%k7C^zfPCcF3r8W(~h>*
zfJu9AdJ`_A#1RC%n)b~VaO
z?9^k~I+`_G+Yj3+@;cY4A?ivk0l)NRf`RM@be4BTpX!E>(kC3A6$*L2UmUV
zdARJ@P|7TR#^iN%Om(pN@oz|a6mpOoY7_8bLo~bm$S@l2%#?0WuJ861rAD0?!fzs5
zd3(0@_6Ye`4P7b{KB~cY;xmV|>Wn^EkOAe_#Q4cYftlRIT_j(@5sr#flsAt|%Of*-
z8Bo$am*V(}$+1SDGT(Oj=hp+|aP!J~I0%z%VqVN$2oD<|E|uqHQGf+t?^*XuVdI?N
z#8o*ec63!a5xaD3G{B3xPA*N0)7EO7Z)ZZ37yT(EF3^Q{
z%&;2Fw9ADoEZgPT=t#2Hw2xL+wazatSqMKsqOfhli1zyUY`AU=NnS<(u=`cdZ)m~g;TYRO$K&*TMh>LZG%Vo`QfnL
zS0%*Rx@FlnxbH(<;`rD_R?~R-G7=$l1ZjF(*e95uO~$ksc(86x{jgzs
z@~!;`$jM}?JrK?<=O~9Vue6dV6hC#1r+Isjyfx0}IzoRW_-$PXK^0%KBIt6HZQ5*g
zXz=*B|Tc
zxGnq%XwO$a^0mJIJS)PL`g!?LT46H!UBT_@_(7bP-XpQPM?X3}uP6qqbI94eBb?54
zp>MPo)2SCZ@n=BFZKYz?W@)P^F0ICyp_49BBith=PP+nfW^?`yti;6XxkNJ!=ylWn
zyo)VEEzeaJ5C`K0GOx2)O_a8HRSXlVlA*Y49)#Bu
z$fRWN%aREkzr7b9guSfhtSln(GWHH^LOH5_20H#$H{_a%KWG$>U#Gj-{%9d2Bz0A$
zBwd4$ZqDvz(0sLqebT)Gdvg<+y^VWu%e8m?FpsaJ3xB;K>QJ18oj$a98UUo`Py
z3;rKU%{e%a!(Sg#1b$itNSjt#Sb%5n(I|L8(M~Q
z0fbHSk-8O)!v2|S`Syb`#F_m*E$QWXIaxL8n2uwYOTr;GoE=40DqeEM*%+j#>}bAH
zaW}g?Inclp1JILG!Xz@|C>-e@@Pi{`xnm?90Y0$d4_0;Yy%>0Xw`yEk`v1#5{
zW3+IL%iwVmbr7^2ZSm(5@-k8UT^Ql7XfRC^ZLDc`nHu7BW-%b6kfvm-l4tan4%xd4aMe5|tvt
zd!#`MUsXz;HW@7Jd4W-PS}E3&8Ha2^R%Hij?-1t(HFY%C9OZp8R<~N@XKQmHV)qIz
z;kILqv?u`?+x`H|mgd%Y)e*}2X0LfPeT3Hp)u^Hk$aR7h?IGV3{K-)iC9T?HypyWM
zzffdJisA>>=n3s$@C=C>a_7_bWioNd^`-GgtJOT)0)17Ms5>8wor^)sZfBUJj;@7&