[issue10716] Modernize pydoc to use better HTML and separate CSS

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

[issue10716] Modernize pydoc to use better HTML and separate CSS

Change by Víctor Terrón : -- nosy: -vterron ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue10716] Modernize pydoc to use better HTML and separate CSS

Julien Palard added the comment: Does someone want to review https://github.com/python/cpython/pull/28651? -- ___ Python tracker ___

[issue10716] Modernize pydoc to use better HTML and separate CSS

Julien Palard added the comment: 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

[issue10716] Modernize pydoc to use better HTML and separate CSS

Change by Julien Palard : -- pull_requests: +27019 pull_request: https://github.com/python/cpython/pull/28651 ___ Python tracker ___

[issue10716] Modernize pydoc to use better HTML and separate CSS

Éric Araujo added the comment: 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

[issue10716] Modernize pydoc to use better HTML and separate CSS

Éric Araujo added the comment: Someone would need to take the patch, apply it to current main branch, fix issues and open a PR. -- versions: +Python 3.11 -Python 3.8 ___ Python tracker

[issue10716] Modernize pydoc to use better HTML and separate CSS

Zac Gross added the comment: 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

[issue10716] Modernize pydoc to use better HTML and separate CSS

Karthikeyan Singaravelan added the comment: Thanks @aroberge for the patch and your efforts on improving it https://aroberge.blogspot.com/2015/01/scratching-itch-improving-pydoc.html -- ___ Python tracker

[issue10716] Modernize pydoc to use better HTML and separate CSS

Change by Karthikeyan Singaravelan : Added file: https://bugs.python.org/file48231/Screen Shot 2019-03-24 at 10.58.33 am.png ___ Python tracker ___

[issue10716] Modernize pydoc to use better HTML and separate CSS

Karthikeyan Singaravelan added the comment: I stumbled upon this issue because I think this is a potential improvement. One of the reasons I don't use it is due to the outdated UI but since it also generates HTML doc for installed packages in a virtual environment I find this to be a useful

[issue10716] Modernize pydoc to use better HTML and separate CSS

Andre Roberge added the comment: On Sat, Mar 23, 2019 at 6:27 PM Raymond Hettinger wrote: > > Raymond Hettinger added the comment: > > I've found the HTML to be useful (-w mode, not running a server) for > generating quick documentation (much lighter weight commitment than using > sphinx).

[issue10716] Modernize pydoc to use better HTML and separate CSS

Raymond Hettinger added the comment: I've found the HTML to be useful (-w mode, not running a server) for generating quick documentation (much lighter weight commitment than using sphinx). I show this in my intro classes and the engineers are usually impressed with it. This is really easy

[issue10716] Modernize pydoc to use better HTML and separate CSS

Change by Karthikeyan Singaravelan : -- nosy: +xtreak ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue10716] Modernize pydoc to use better HTML and separate CSS

Change by Raymond Hettinger : -- versions: +Python 3.8 -Python 3.7 ___ Python tracker ___

[issue10716] Modernize pydoc to use better HTML and separate CSS

R. David Murray added the comment: My memory of the thread (I haven't gone back and checked) was that the thought was to drop html output altogether because the sphinx docs were more useful for anyone wanting to use html, and network connectivity was so universal in this day and age that

[issue10716] Modernize pydoc to use better HTML and separate CSS

Terry J. Reedy added the comment: Since David added me as nosy, I will address the IDLE issues raised above. But first, a question. Does 'deprecating HTML output' merely mean deprecating the old output in favor of new and better HTML output, or deprecating having any html output, which would

[issue10716] Modernize pydoc to use better HTML and separate CSS

R. David Murray added the comment: That sounds like a reasonable argument to me. To clarify something in my last post: 5 should be skipped in terms of opening new issues because it is already covered by this issue. If Terry would like to see pydoc enhanced to support idle, then I think that

[issue10716] Modernize pydoc to use better HTML and separate CSS

Serhiy Storchaka added the comment: I disagree with deprecating HTML output. Pydoc has builtin HTTP server, it provides the documentation with hyperlinks. It would be nice if IDLE use this feature for displaying interactive help. I think we should enhance HTML output not just by making it

[issue10716] Modernize pydoc to use better HTML and separate CSS

R. David Murray added the comment: You sound like you think we want to get rid of pydoc, which is certainly not true :). As I understand it it is only the *html* output of pydoc that we are considering deprecating. Yes, you should open separate issues for your proposed changes. 1 and 2

[issue10716] Modernize pydoc to use better HTML and separate CSS

Peter Lovett added the comment: I see that pydoc still useful, and have 6 points I'd like to work on with pydoc. Is this too much for one issue? Should I break bits out to another issue(s)? Although it would make sense to do it all in one go. ---

[issue10716] Modernize pydoc to use better HTML and separate CSS

R. David Murray added the comment: I've removed the easy tag. (Aside for those who can do the operation: to remove all tags from an issue one must select '-no selection-'; just ctrl-clicking the last tag to remove its highlight doesn't work...or at least that's what I remember, I didn't

[issue10716] Modernize pydoc to use better HTML and separate CSS

Changes by R. David Murray : -- keywords: -easy ___ Python tracker ___ ___

[issue10716] Modernize pydoc to use better HTML and separate CSS

Mariatta Wijaya added the comment: Hi Andre, You can subscribe to the core mentorship mailing list here: https://mail.python.org/mailman/listinfo/core-mentorship Once you subscribed, you'll get access to the said discussion :) It is not required, but it's a great place to ask questions or

[issue10716] Modernize pydoc to use better HTML and separate CSS

Andre Roberge added the comment: When rhettinger created this issue, the goal was "Pydoc currently generated 1990's style html which mixes content and presentation, making it very difficult for users to customize the appearance of the output. ... Please convert it to simple, validated HTML

[issue10716] Modernize pydoc to use better HTML and separate CSS

Mariatta Wijaya added the comment: Thanks for the update, Berker. Would you be able to remove the 'easy' keyword from this ticket? I'll keep myself in the nosy list as I'm interested to learn about this anyway :) -- ___ Python tracker

[issue10716] Modernize pydoc to use better HTML and separate CSS

Berker Peksag added the comment: (As a result of the discussion at http://psf.upfronthosting.co.za/roundup/meta/issue605, I started to re-triage all easy issues.) I don't think this is a suitable task for new contributors. It requires a) good HTML and CSS knowledge b) familiarity with pydoc

[issue10716] Modernize pydoc to use better HTML and separate CSS

Changes by Mariatta Wijaya : -- nosy: +Mariatta ___ Python tracker ___ ___

[issue10716] Modernize pydoc to use better HTML and separate CSS

Changes by Peter Lovett : -- nosy: +PeterLovett ___ Python tracker ___ ___

[issue10716] Modernize pydoc to use better HTML and separate CSS

Changes by Adam : -- nosy: +azsorkin ___ Python tracker ___ ___ Python-bugs-list mailing

[issue10716] Modernize pydoc to use better HTML and separate CSS

Frédéric Jolliton added the comment: Oh god. The HTML produced by pydoc is awful. This is absolutely nothing modern about it. The code itself hurts my brain. It feels very old (14 years old..), and the HTML production is overly complex, and hard to check regarding correct quoting/escaping.

[issue10716] Modernize pydoc to use better HTML and separate CSS

Alex Walters added the comment: Isn't this whats sphinx's apidoc is for? -- nosy: +tritium ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10716 ___

[issue10716] Modernize pydoc to use better HTML and separate CSS

Changes by Raymond Hettinger raymond.hettin...@gmail.com: -- keywords: +easy -patch versions: +Python 3.6 -Python 3.5 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10716 ___

[issue10716] Modernize pydoc to use better HTML and separate CSS

Ismail Donmez added the comment: Any update on this? Would be nice to have this for 3.5 release. -- nosy: +cartman ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10716 ___

[issue10716] Modernize pydoc to use better HTML and separate CSS

Andre Roberge added the comment: If anyone is still interested in this, I did that today (scratching a personal itch - not knowing this had been filed before). What I have done: 1. Moved all the font/color information to a separate css file 2. Used html5 syntax. 3. Recreated a css style

[issue10716] Modernize pydoc to use better HTML and separate CSS

Andre Roberge added the comment: Rather than creating a new branch, I took another copy of pydoc.py, kept its name, and only applied the html-related changes in it. (no new -c option, no unrelated PEP8 changes to the best of my knowledge.) The original pydoc.py referred to

[issue10716] Modernize pydoc to use better HTML and separate CSS

Andre Roberge added the comment: I could certainly create a new branch and revert the PEP8 changes and the new -c option, but before I do this, could you confirm that the new html output would be deemed to be acceptable? -- ___ Python tracker

[issue10716] Modernize pydoc to use better HTML and separate CSS

Berker Peksag added the comment: Thanks! Apparently, we were working on the same issue simultaneously. I was working on the HTML and CSS parts (didn't touch to Lib/pydoc.py yet). I can combine our work, if you could - create a separate branch (no need to be a Hg repo, I can create a patch

[issue10716] Modernize pydoc to use better HTML and separate CSS

Ezio Melotti added the comment: Is there a prefered style guide for css that we should use? If you mean indentation/spacing, my preferred style is: selector { property1: value1; property2: value2; ... } FWIW I agree an HTML5 doctype should be used. --

[issue10716] Modernize pydoc to use better HTML and separate CSS

Ron Adam added the comment: I'm going to go over this issue again with fresh eyes after having been away for some time. Recent experience with another project has helped answer some of the questions I had earlier. Particulary, how not to over specifying class names and id's. This should

[issue10716] Modernize pydoc to use better HTML and separate CSS

Víctor Terrón quinta...@gmail.com added the comment: I would like to take on this issue if, as it seems, Ron is no longer working on it. I'm thinking of using HTML5 and maybe replicating the default output of Sphinx. -- nosy: +vterron ___ Python

[issue10716] Modernize pydoc to use better HTML and separate CSS

Ezio Melotti ezio.melo...@gmail.com added the comment: Using an HTML5 doctype is ok, but I'm not sure it's a good idea to use new HTML5 elements/features yet (those shouldn't be necessary anyway, so basically you should end up with valid HTML 4 strict with an HTML5 doctype). --

[issue10716] Modernize pydoc to use better HTML and separate CSS

Changes by Éric Araujo mer...@netwok.org: -- title: Modernize pydoc to use CSS - Modernize pydoc to use better HTML and separate CSS ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10716 ___

[issue10716] Modernize pydoc to use better HTML and separate CSS

Changes by Éric Araujo mer...@netwok.org: -- assignee: lukasz.langa - eric.araujo stage: - patch review versions: +Python 3.4 -Python 3.3 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue10716