[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Debian RT - please install an additional dependency for Sphinx-based documentation on wolkenstein



Hello DSA


Inline with the migration of documentation to restructedText / Sphinx there is
the need for one more package to be installed on www-master:

A somewhat longstanding topic is the creation of a Debian-style html theme for
those documents (currently the style of those docs is not really in-line with
the color scheme on debian.org. See [2] for example).
Thanks to Stéphane Blondon we have a proposal now (see [1]), which is based
on a theme from readthedocs.org.
To make that work, we need to have python3-sphinx-rtd-theme installed on
www-master (?).
Without that package, we have a broken html layout, which can be seen at
[3] currently.

Please note, that this dependency is not a build-dependency, but also needed
during runtime (aka: on every www mirror which serves those Sphinx-based
documents we need to have python3-sphinx-rtd-theme installed, to make the
new theme work for the website visitor).
However, I couldn't find any other stanza for www.debian.org web mirrors
than www-master.
Are all www mirrors deployed from this stanza, or how is it supposed to
work?


I'm attaching a patch for the debian.org-www-master.debian.org
dependencies including the new dependency, in the hope that it is correct
this way.


Kind regards,
Holger

[1] https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=915583#25
[2] https://www.debian.org/doc/manuals/developers-reference/index.en.html
[3] https://www.debian.org/doc/debian-policy/

-- 
Holger Wansing <hwansing@mailbox.org>
PGP-Fingerprint: 496A C6E8 1442 4B34 8508  3529 59F1 87CA 156E B076
>From 72c0871fa470eeb30e8d4f3afa7d2b1f6ae17f68 Mon Sep 17 00:00:00 2001
From: Holger Wansing <hwansing@mailbox.org>
Date: Sun, 24 Mar 2024 18:59:13 +0100
Subject: [PATCH] Add python3-sphinx-rtd-theme as dependency for www-master, to
 get a nice Debian-style html theme for our Sphinx-based documents

---
 debian/changelog | 4 ++++
 debian/control   | 1 +
 2 files changed, 5 insertions(+)

diff --git a/debian/changelog b/debian/changelog
index ef3d457..ffcc71e 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -8,6 +8,10 @@ debian.org (74) UNRELEASED; urgency=medium
   * Drop debian.org-lintian.debian.org
   * Drop debian.org-lintian-new.debian.org
 
+  [ Holger Wansing ]
+  * www-master - additional dependency for Sphinx-based documentation:
+    + python3-sphinx-rtd-theme
+
  -- Pierre-Elliott Bécue <peb@debian.org>  Mon, 18 Mar 2024 22:01:07 +0100
 
 debian.org (73) stable; urgency=medium
diff --git a/debian/control b/debian/control
index 4de3955..cef3776 100644
--- a/debian/control
+++ b/debian/control
@@ -340,6 +340,7 @@ Depends: debiandoc-sgml,
 	python3-distro-info,
 	python3-sphinx,
 	python3-stemmer,
+	python3-sphinx-rtd-theme,
 	tex-gyre,
 	texinfo,
 	fonts-freefont-otf,
-- 
2.39.2


Reply to: