This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: pydoc -w doesn't produce proper HTML
Type: behavior Stage:
Components: Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: doko, georg.brandl
Priority: normal Keywords: needs review, patch

Created on 2009-04-05 15:03 by doko, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
pydoc.diff doko, 2009-04-05 15:03 patch
Messages (3)
msg85509 - (view) Author: Matthias Klose (doko) * (Python committer) Date: 2009-04-05 15:03
[forwarded from http://bugs.debian.org/411524]

"""
If you feed the output of pydoc -w [some module] to the w3 validator, it
complains about two issues:
firstly, the doctype is wrong. It should be:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
not 
<!doctype...
[note case]

Secondly, no charset is specified. Just doing
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" > in
the head
would probably do.
"""
msg85563 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-04-05 21:10
The DOCTYPE fix is fine.  However, I'm not sure about the charset -- why
should it be UTF-8?  Pydoc will output anything in docstrings, which can
be in any encoding.
msg85851 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-04-11 10:57
I fixed the DOCTYPE in trunk/3k r71443/71444, and the encoding issue in
3k only, because there the encoding is well-defined, in r71445.
History
Date User Action Args
2022-04-11 14:56:47adminsetgithub: 49948
2009-04-11 10:57:08georg.brandlsetstatus: open -> closed
keywords: patch, patch, needs review
resolution: fixed
messages: + msg85851
2009-04-05 21:10:11georg.brandlsetkeywords: patch, patch, needs review

messages: + msg85563
2009-04-05 15:03:33dokocreate