Source: python3-defaults
Version: 3.10.4-1
Severity: normal

Dear Maintainer,

The Python Policy[0] is missing from the Debian doc-base[1][2] system.
In the debian directory of the python3-defaults source package there is
a file, 'python.doc-base.python-policy'[3], that appears to have been
copied over from the earlier python-defaults source package. (The
description in that file refers to Python Policy as still having a
draft status which I don't think has been true for quite a while. The
file 'README.Debian' in the debian directory also refers to the Python
Policy as a draft. That file also refers to a python3.6 directory as if
it that is the current release of python, so that file should probably
be updated or deleted.) Because the filename
'python.doc-base.python-policy' starts with 'python.', it doesn't
correspond to any current binary package, so dh_installdocs[4] doesn't
end up installing it anywhere.

Starting with python3-defaults 3.9.2-1, the Python Policy was converted
from DocBook to Sphinx format. The file 'python.doc-base.python-policy'
still mentions the DocBook format, so that will need to be updated.
Also starting from that version, the generated HTML version of the
Python Policy files were moved to the python3-dev binary package, but
the generated plaintext version of the policy was left in the python3
package. AIUI, the doc-base system doesn't really support multiple
formats of the same document in different binary packages. All included
formats of a document need to be in the same binary package. It is,
of course, up to you how you'd like to resolve that, whether that means
moving the plaintext version to python3-dev, moving the HTML back to
python3, dropping the plaintext version, whatever.

[0] https://www.debian.org/doc/packaging-manuals/python-policy/
[1] https://www.debian.org/doc/debian-policy/ch-opersys.html#s-doc-base
[2] /usr/share/doc/doc-base/doc-base.html/index.html
[3] 
https://sources.debian.org/src/python3-defaults/3.10.4-1/debian/python.doc-base.python-policy/
[4] 
https://manpages.debian.org/bookworm/debhelper/dh_installdocs.1.en.html#debian/~5

-- 
Plasma

Reply via email to