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

Bug#932957: Please migrate Release Notes to reStructuredText



Followup-For: Bug #932957
X-Debbugs-Cc: hwansing@mailbox.org

Hi Holger,

> Please note the &oldreleasename; in the URL!
> I could not get this working with sphinx (if someone knows better, please
> contact me!)

Could the 'extlinks' feature[1] of Sphinx be helpful to migrate those?

(it allows defining URL pattern aliases, so for example :oldreleasenotes: could
map to https://www.debian.org/releases/bullseye/releasenotes and :releasenotes:
could map to https://www.debian.org/releases/bookworm/releasenotes for D12)

Parameters are supported too, and that could be useful for package-or-filepath
refs (re: grep -r '`.*<' source |grep -o '<https.*>' | sort | uniq -c |sort -n)

> Beside this, I need help to adapt the buildchain, to get the possibility of
> building the release-notes for the different architectures.
> I have no python knowledge, so I will most likely not get this running myself.

I'll try to take a look into that soon to see what I can find out.  Do you
know how the current docbook-based build varies by architecture?

Perhaps we can borrow some build scripting from developers-reference and/or
debian-policy.. but I suppose those don't have per-architecture output.

> And the last point is the integration into the debhelper tools: I don't know
> if it is required, to have the release-notes fit for building as a whole
> package with sbuild or debuild or similar. Salsa tries to build it via CI
> at every push, but currently fails.

It's possible I've misunderstood, but would be the goals here to be to get
the release-notes documentation built by CI, and also for it to be distributed
as a Debian package itself?

(someone who knows more may correct me, but I think it would be great to have
the package available for install using apt in addition to the website)

Cheers,
James

[1] -  https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html


Reply to: