bpo-10716: Migrating pydoc to html5. by JulienPalard · Pull Request #28651 · python/cpython

JulienPalard · 2021-09-30T13:30:50Z

I tried myself at porting pydoc to html5.

I though (hoped?) the commit would be smaller, I tried to keep it as small as possible. I did not tried to enhance the graphical result, I just focused on HTML modernisation as a fist step.

https://bugs.python.org/issue10716

JulienPalard · 2021-09-30T14:53:19Z

Ohhh, interesting, cgitb depends on pydoc, so if I use css in pydoc... oh wow.

JulienPalard · 2021-09-30T16:42:03Z

So I modified cgitb a bit to not depend on html rendered by pydoc.

I also had to modify pydoc test which were extremely strict in the output expected, I tried to still check that every bit of important info are given, while not being strict on the HTML used.

JulienPalard · 2021-09-30T16:57:31Z

TIL about ServerHTMLDoc...

Lib/cgitb.py

Lib/pydoc.py

JulienPalard · 2021-10-07T11:56:36Z

I'd like to merge this, does someone still want to proof-read first?

merwok · 2021-10-07T15:00:19Z

I haven’t had a chance to run it locally to see the results yet.
Maybe you have screenshots?

merwok · 2021-10-07T15:38:37Z

This could get a note in the release notes (for pydoc and xmlrpc — cgitb is unchanged)

JulienPalard · 2021-10-08T02:07:00Z

Here come the screenshots, side by side:

There's a few differences, in the height of the title bar for example.

JulienPalard · 2021-10-08T02:13:14Z

This could get a note in the release notes (for pydoc and xmlrpc — cgitb is unchanged)

True, done.

Lib/test/test_pydoc.py

Misc/NEWS.d/next/Library/2021-10-08-04-11-55.bpo-10716.QSRVK2.rst

merwok · 2021-10-08T02:54:15Z

Thank you for your efforts in tackling this! It was needed and is the basis for future improvements.

I have added some final questions on some details. (If you make changes, please avoid force-pushing to make reviewing easier.)

JulienPalard · 2021-10-09T07:58:21Z

Thanks @merwok and @rhettinger for the review!

the-knights-who-say-ni added the CLA signed label Sep 30, 2021

bedevere-bot added the awaiting core review label Sep 30, 2021

JulienPalard added skip news and removed awaiting core review labels Sep 30, 2021

JulienPalard force-pushed the mdk/pydoc branch from 1576d72 to e1944db Compare September 30, 2021 13:40

JulienPalard force-pushed the mdk/pydoc branch from e1944db to 5eaf66a Compare September 30, 2021 15:10

JulienPalard requested a review from ethanfurman as a code owner September 30, 2021 15:10

JulienPalard force-pushed the mdk/pydoc branch 3 times, most recently from 293abb9 to 20db0b3 Compare September 30, 2021 16:40

merwok reviewed Sep 30, 2021

View reviewed changes

Lib/cgitb.py Outdated Show resolved Hide resolved

merwok reviewed Sep 30, 2021

View reviewed changes

Lib/pydoc.py Outdated Show resolved Hide resolved

merwok reviewed Sep 30, 2021

View reviewed changes

Lib/pydoc.py Outdated Show resolved Hide resolved

JulienPalard force-pushed the mdk/pydoc branch 2 times, most recently from c4c9cfc to 98a3bc3 Compare September 30, 2021 21:34

serhiy-storchaka added the type-feature A feature request or enhancement label Oct 1, 2021

merwok approved these changes Oct 7, 2021

View reviewed changes

bedevere-bot added the awaiting merge label Oct 7, 2021

Migrating pydoc to html5.

de955fe

JulienPalard force-pushed the mdk/pydoc branch from 98a3bc3 to de955fe Compare October 8, 2021 02:12