[issue10716] Modernize pydoc to use CSS

[Ezio Melotti]

Ezio Melotti <ezio.melotti at gmail.com> added the comment:

A few comments about css_v2.diff:
1) when the value is '0', there's no need to specify the unit (e.g. 0em);
2) when the color is specified the background-color should be specified as well (and vice versa);
3) hex colors (e.g. #00FF00) should be preferred to named colors (e.g. gray);
4) some selectors and properties don't work with older browsers (e.g. E > F or min-width);
5) there are a few empty dl.*{} that I would remove (unless you plan to fill them later);
6) the style I prefer for CSS is:
selector {
  property: value;
}

Regarding the HTML:
1) using an HTML 4.01 strict doctype would be better;
2) all the style-related attributes and elements should be removed (e.g bgcolor, valign, <font>);
3) using .red { color: red; } is not a good idea. Classes' names should describe the role of the element (e.g. header, entry) and not their style (otherwise when you want to change the page with a blue theme you'll end up with a .red { color: blue; }). If the colors are passed directly to the HTML they should be removed and left to the CSS(s) only. I don't know the code well enough to say if this is doable and/or if it requires a deprecation first;
4) the <li>s in html_header() should be closed, same for all the other elements that support a closing tag, even if optional (e.g. <dt>, <dd>);

There are also some minor incontinences in the indentantion, e.g.:
+        link_list = ['<a href="%s.html">%s</a>' % (name, name)
+                    for name in sys.builtin_module_names
+                    if name != '__main__']
+        contents = [html.index_columns('Built-in modules',
+                    link_list, css_class='section modules')]
+        link_list = ['<a href="%s.html">%s</a>' % (name, name)
+                      for name in sorted(Helper.keywords.keys())]
(the "contents" one is indented correctly), and some extra space after the '('.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue10716>
_______________________________________