Bug#987943: www.debian.org: Developers Reference: Sphinx search non-functional: searchindex.js missing

2024-04-07 Thread Holger Wansing 
Hi,

Holger Wansing  wrote (Sat, 25 Nov 2023 12:43:24 +0100):
> In the meantime things have evolved, Sphinx has changed its way to
> deal with this; see 
> 
> 
> Thus, the current developers-reference built on a bookworm or later system
> leads to a output, where the search is working.
> Can be viewed at 
> 
> (also with a different html theme, BTW)
> 
> 
> So, when wolkenstein gets updates to bookworm (currently on bullseye)
> it will just, I guess.

Sorry, the above was complete nonsens, since for Developers Reference on the 
website we use the binary Debian package as a basis, which is built by
buildds, so on unstable. Thus the Sphinx version on wolkenstein is completely 
irrelevant.

I mixed that up with the release-notes, which I have worked on to migrate to
Sphinx: since there is no such package like 'release-notes' in the archive,
they in fact need to be built from scratch on wolkenstein.

So ...

$ time_machine start target=submitting-date

... we are back to the beginning:

Stefano Rivera  wrote:
> Sphinx search is broken on the developers reference:
> https://www.debian.org/doc/manuals/developers-reference/searchindex.js
> is 404.

Note: I'm working on debian-policy now, which has also switched to Sphinx;
as debian-policy shows the same problem, I think it's a systematic issue and
thus a solution for this will work for other sphinx-based manuals as well
(hopefully).

First, I focused on the symlinks to several .js scripts in _static, which point
to not existing targets. That has been mentioned at several places, and drawed
my attention.
After several attempts I have all those scripts existing now on the relevant 
place at https://www.debian.org/doc/debian-policy/_static/,
however the search is still not working :-((

But then --- guess what: the subject says it all:
"searchindex.js is missing" !

Indeed, that file is existing here after a local build of the package, but
is missing on our webserver.
That's because the 7doc script in webmaster's cron repo (to push /doc content on
the website) does only process html files in the root directoriy of the manual, 
no .js files.

I have prepared a build of debian-policy with all needed javascript scripts
and that searchindex.js file at
https://people.debian.org/~holgerw/new-rtd-sphinx-theme-for-debian/debian-policy/debian-policy/

Everything works fine there as far a I see (with a desktop firefox and brave
browser, as well as with the mobile versions of those browsers on my 
smartphone).
Feel free to test with more browsers/platforms/whatever.

I guess I will need to trim the 7doc script once again - h ...


So long
Holger


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

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

2024-04-07 Thread Debian Bug Tracking System 
Your message dated Sun, 7 Apr 2024 13:00:43 +0200
with message-id <20240407130043.894c57d79acee013d4dda...@mailbox.org>
and subject line Re: Bug#1053549: Create a Debian theme for documentation based 
in Sphinx (reStructuredText)
has caused the Debian Bug report #1053549,
regarding Create a Debian theme for documentation based in Sphinx 
(reStructuredText)
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact ow...@bugs.debian.org
immediately.)


-- 
1053549: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1053549
Debian Bug Tracking System
Contact ow...@bugs.debian.org with problems
--- Begin Message ---

Package: www.debian.org
Severity: normal
User: debian-www@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
--- End Message ---
--- Begin Message ---
Hi,

Laura Arjona Reina  wrote (Fri, 6 Oct 2023 09:35:09 +0200):
> 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.

Thanks to Stéphane Blondon, we have a nice Debian theme for Sphinx now, and
I managed to get it to the website in the end so far, currently visible at
debian-policy:
https://www.debian.org/doc/debian-policy/index.html

I had to deal with some missing javascript files as well, to make the 
sidebar appear/disappear on small screens like smartphones, but that works
now.

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.

Javascript leaves some open issues, but for those I will follow-up on some 
existing javascript bugs, we already have for the website/manuals.


Holger


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

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

2024-04-07 Thread Holger Wansing 
Hi,

Laura Arjona Reina  wrote (Fri, 6 Oct 2023 09:35:09 +0200):
> 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.

Thanks to Stéphane Blondon, we have a nice Debian theme for Sphinx now, and
I managed to get it to the website in the end so far, currently visible at
debian-policy:
https://www.debian.org/doc/debian-policy/index.html

I had to deal with some missing javascript files as well, to make the 
sidebar appear/disappear on small screens like smartphones, but that works
now.

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.

Javascript leaves some open issues, but for those I will follow-up on some 
existing javascript bugs, we already have for the website/manuals.


Holger


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