Google Groups no longer supports new Usenet posts or subscriptions. Historical content remains viewable.
Dismiss

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

1 view
Skip to first unread message

Holger Wansing

unread,
Dec 30, 2023, 5:20:05 PM12/30/23
to
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 <hwan...@mailbox.org>
PGP-Finterprint: 496A C6E8 1442 4B34 8508 3529 59F1 87CA 156E B076
0001-Switch-to-new-theme-for-sphinx-based-documentation.patch

Holger Wansing

unread,
Dec 31, 2023, 4:10:05 AM12/31/23
to
Hi Sean and Stéphane,

Am 30. Dezember 2023 23:43:17 MEZ schrieb Sean Whitton <spwh...@spwhitton.name>:
>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?
(<http://stephane.yaal.fr/tmp/policy/>)

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

Holger Wansing

unread,
Jan 1, 2024, 4:10:06 PM1/1/24
to
Hi,

Holger Wansing <hwan...@mailbox.org> 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 <spwh...@spwhitton.name>:
> >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?
> (<http://stephane.yaal.fr/tmp/policy/>)

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 <hwan...@mailbox.org>
PGP-Fingerprint: 496A C6E8 1442 4B34 8508 3529 59F1 87CA 156E B076

Holger Wansing

unread,
Jan 3, 2024, 4:50:04 PM1/3/24
to
[ Hrrr, I sent this to the wrong bug #1059730; so resending to the correct
one #915583 for completeness ]


Holger Wansing <hwan...@mailbox.org> 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 <spwh...@spwhitton.name>:
> >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?
> (<http://stephane.yaal.fr/tmp/policy/>)

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 <hwan...@mailbox.org>
PGP-Fingerprint: 496A C6E8 1442 4B34 8508 3529 59F1 87CA 156E B076
0 new messages