Bug#1053549: Create a Debian theme for documentation based in Sphinx (reStructuredText)

2024-04-14 Thread James Addison
On Sat, 13 Apr 2024 at 06:48, Holger Wansing  wrote:
> Am 11. April 2024 23:52:52 MESZ schrieb James Addison :
> >On Sun, 7 Apr 2024 13:00:43 +0200, Holger wrote:
> >> The only thing which is not working currently, is the search functionality,
> >> but since that's not theme-specific I guess (please correct me, if I'm
> >> wrong), I close this bug.
> >
> >The theme looks great, and I agree with closing this bug.  However, so that
> >we don't overlook another potential python3-sphinx bug: could you report the
> >problem that you encountered?  (I contribute to upstream and may be able to
> >help with investigating that)
>
> It's not a bug in sphinx or something like that.
> The issue was in the build process for the website, what lead to some missing
> files in the manuals' tree (javascript script files and the searchindex.js).
>
> Everything fine for now.

Ok; thank you!

> I'm currently working on switching the Debian release-notes to the new theme,
> and that might bring some issues, since the release-notes have translations as
> well (this was not the case for the debian-policy).
>
> So maybe I come back to you in such case, if that's ok?

I'm less knowledgeable about the translation logic than the JavaScript search
functionality, however yes, feel free to include me on cc for Sphinx bugreports
and I'll help if-and-when possible.

James



Bug#1053549: Create a Debian theme for documentation based in Sphinx (reStructuredText)

2024-04-12 Thread Holger Wansing
Hi James,

Am 11. April 2024 23:52:52 MESZ schrieb James Addison :
>Hi Holger,
>
>On Sun, 7 Apr 2024 13:00:43 +0200, Holger wrote:
>> The only thing which is not working currently, is the search functionality,
>> but since that's not theme-specific I guess (please correct me, if I'm
>> wrong), I close this bug.
>
>The theme looks great, and I agree with closing this bug.  However, so that
>we don't overlook another potential python3-sphinx bug: could you report the
>problem that you encountered?  (I contribute to upstream and may be able to
>help with investigating that)

It's not a bug in sphinx or something like that.
The issue was in the build process for the website, what lead to some missing 
files in the manuals' tree (javascript script files and the searchindex.js).

Everything fine for now.

I'm currently working on switching the Debian release-notes to the new theme, 
and that might bring some issues, since the release-notes have translations as 
well (this was not the case for the debian-policy).

So maybe I come back to you in such case, if that's ok?


Thanks
Holger


-- 
Sent from /e/ OS on Fairphone3



Bug#1053549: Create a Debian theme for documentation based in Sphinx (reStructuredText)

2024-04-11 Thread James Addison
Hi Holger,

On Sun, 7 Apr 2024 13:00:43 +0200, Holger wrote:
> The only thing which is not working currently, is the search functionality,
> but since that's not theme-specific I guess (please correct me, if I'm
> wrong), I close this bug.

The theme looks great, and I agree with closing this bug.  However, so that
we don't overlook another potential python3-sphinx bug: could you report the
problem that you encountered?  (I contribute to upstream and may be able to
help with investigating that)

Thanks,
James



Bug#1053549: Create a Debian theme for documentation based in Sphinx (reStructuredText)

2023-10-06 Thread Laura Arjona Reina

Package: www.debian.org
Severity: normal
User: debian-...@lists.debian.org
Usertags: design
X-Debbugs-CC: 
debian-...@lists.debian.org,design-de...@alioth-lists.debian.net.


Dear website, documentation and design teams,

Several documentation manuals are being generated now using 
ReStructuredText and Sphinx, and it would be nice that a Debian theme in 
Sphinx is created and used to match our docs appearance with the Debian 
website colours etc.


Currently in the website we publish, at least:

* Debian Policy: https://www.debian.org/doc/debian-policy/
* Debian Developers Reference: 
https://www.debian.org/doc/manuals/developers-reference/index.en.html
* Testing Release notes: currently in 
https://www.debian.org/releases/testing/release-notes/ but that may change


The upstream documentation about theming is here:
 http://www.sphinx-doc.org/en/stable/theming.html

Please take into account that currently the machine www-master where the 
website is built runs bullseye (sphinx version: 3.4.3-2, but at some 
time it will be upgraded to bookworm (sphinx version: 5.3.0-4).


Kind regards
--
Laura Arjona Reina
https://wiki.debian.org/LauraArjona