python / cpython

The Python programming language
https://www.python.org
Other
62.86k stars 30.11k forks source link

Modernize pydoc to use better HTML and separate CSS #54925

Closed rhettinger closed 1 year ago

rhettinger commented 13 years ago
BPO 10716
Nosy @birkenfeld, @rhettinger, @terryjreedy, @abalkin, @aroberge, @ezio-melotti, @merwok, @bitdancer, @ambv, @berkerpeksag, @serhiy-storchaka, @tritium21, @JulienPalard, @Mariatta, @tirkarthi, @brickman1444
PRs
  • python/cpython#28651
  • Files
  • css_v2.diff: css support in the new pydoc pages.
  • css_v3.diff: css support for the new pydoc pages.
  • css_master.diff
  • Screen Shot 2019-03-24 at 10.58.33 am.png: pydoc with updated CSS and bootstrap
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields: ```python assignee = None closed_at = None created_at = labels = ['type-feature', 'library', '3.11'] title = 'Modernize pydoc to use better HTML and separate CSS' updated_at = user = 'https://github.com/rhettinger' ``` bugs.python.org fields: ```python activity = actor = 'mdk' assignee = 'none' closed = False closed_date = None closer = None components = ['Library (Lib)'] creation = creator = 'rhettinger' dependencies = [] files = ['20216', '20236', '48230', '48231'] hgrepos = [] issue_num = 10716 keywords = ['patch'] message_count = 57.0 messages = ['124119', '124144', '124147', '124157', '124158', '124159', '124162', '124164', '124176', '124177', '124179', '124181', '124195', '124306', '124825', '124857', '124858', '124863', '125033', '125049', '125111', '125113', '125122', '127542', '130629', '165401', '165406', '183304', '183319', '234936', '234940', '234941', '234942', '236962', '246917', '246920', '277934', '278084', '278089', '278090', '278098', '278119', '278123', '278126', '278127', '278166', '278191', '338700', '338703', '338716', '338717', '397265', '397353', '397354', '402962', '403397', '403520'] nosy_count = 21.0 nosy_names = ['georg.brandl', 'rhettinger', 'terry.reedy', 'belopolsky', 'ron_adam', 'donmez', 'aroberge', 'ezio.melotti', 'eric.araujo', 'r.david.murray', 'PeterLovett', 'lukasz.langa', 'berker.peksag', 'serhiy.storchaka', 'tritium', 'azsorkin', 'Fr\xc3\xa9d\xc3\xa9ric Jolliton', 'mdk', 'Mariatta', 'xtreak', 'brickman1444'] pr_nums = ['28651'] priority = 'normal' resolution = None stage = 'patch review' status = 'open' superseder = None type = 'enhancement' url = 'https://bugs.python.org/issue10716' versions = ['Python 3.11'] ```

    tirkarthi commented 5 years ago

    Thanks @aroberge for the patch and your efforts on improving it https://aroberge.blogspot.com/2015/01/scratching-itch-improving-pydoc.html

    8b28d72f-ba96-4654-b444-63c22cf5a419 commented 3 years ago

    Hey all, I'd like to note my interest in this issue getting addressed. I have a use case where I'd like to generate documentation for a module and using non-core modules to do that requires some approval that I would like to avoid.

    I understand there are other more important issues but this issue has had a patch waiting for review for ten years. Can we move this forward somehow?

    merwok commented 3 years ago

    Someone would need to take the patch, apply it to current main branch, fix issues and open a PR.

    merwok commented 3 years ago

    On second thought, this issue is not purely programming, but also has a UI component. Better HTML and separated CSS would be good, but before that I think we’d need someone with design chops to mock up a better page layout and style (better than big coloured rectangles!), then I think have a discussion on python-dev (not to discuss all details in committee, but to validate the overall change).

    JulienPalard commented 3 years ago

    Tried myself at it.

    I'm not a front-end guy, fasten your seatbelts.

    I tried to keep it minimal, but after some work the change is not that small, I focused on the HTML modernization only, not the design (to try to land at least a first step toward modernization).

    JulienPalard commented 3 years ago

    Does someone want to review https://github.com/python/cpython/pull/28651?

    JulienPalard commented 3 years ago

    New changeset c91b6f57f3f75b482e4a9d30ad2afe37892a8ceb by Julien Palard in branch 'main': bpo-10716: Migrating pydoc to html5. (GH-28651) https://github.com/python/cpython/commit/c91b6f57f3f75b482e4a9d30ad2afe37892a8ceb

    furkanonder commented 1 year ago

    @JulienPalard The issue seems to have been solved. I think we can issue the problem.