[issue26462] Patch to enhance literal block language declaration

Martin Panter added the comment: I backported the patch to 2.7. Now I get no warnings about syntax highlighting from 2.7 (there were only a few reported before). -- resolution: -> fixed stage: needs patch -> resolved status: open -> closed ___

[issue26462] Patch to enhance literal block language declaration

Roundup Robot added the comment: New changeset 6e9a040a993f by Martin Panter in branch '2.7': Issue #26462: Doc: avoid literal_block warnings, fix syntax highlighting. https://hg.python.org/cpython/rev/6e9a040a993f -- ___ Python tracker

[issue26462] Patch to enhance literal block language declaration

Martin Panter added the comment: Okay, leaving this open for a 2.7 patch. BTW thanks for your work; I tried to tackle these warnings a while ago, but I didn’t know enough about Sphix/RST/etc. The 2.7 change should be fairly easy; I can give it a crack if you’re not that interested in 2.7.

[issue26462] Patch to enhance literal block language declaration

Changes by Martin Panter : -- versions: +Python 2.7 ___ Python tracker ___ ___

[issue26462] Patch to enhance literal block language declaration

Roundup Robot added the comment: New changeset 8bac90be by Martin Panter in branch '3.5': Issue #26462: Doc: reduce literal_block warnings, fix syntax highlighting. https://hg.python.org/cpython/rev/8bac90be New changeset 6fbb7c9d77c6 by Martin Panter in branch 'default': Issue #26462:

[issue26462] Patch to enhance literal block language declaration

Julien added the comment: Decorater: Colors used by the documentation are defined here: https://github.com/sphinx-doc/sphinx/blob/master/sphinx/pygments_styles.py#L22 you can easily modify it and rebuild the doc ``(cd Doc; make html)``. Take a look at existing themes

[issue26462] Patch to enhance literal block language declaration

Julien added the comment: Martin: OK, let's apply this to 3.6 / 3.5 with this one, and I'll provide independent patch for 2.7 if needed (long time without building 2.7 doc). -- ___ Python tracker

[issue26462] Patch to enhance literal block language declaration

R. David Murray added the comment: Martin: your summary is correct. A new feature should also have a What's New entry, of course; I think that's the only essential you left out. Decorator: general comments (eg: color of docs, etc) aren't really useful comments on a specific bug report, and

[issue26462] Patch to enhance literal block language declaration

Martin Panter added the comment: Usually my technique is to apply the 3.6 patch to 3.5, fix up any conflicts, and leave the 3.6-only bits out (which get rejected by the patch process anyway). But dedicated patch(es) may be useful. Especially for 2.7, where there are probably independent

[issue26462] Patch to enhance literal block language declaration

Decorater added the comment: Also I was thinking maybe I could figure out how to Add in asyncio to 2.7 anyway (well latest one that is) because why not. With as many things using asyncio now days it would be cake for those python 2 users. -- ___

[issue26462] Patch to enhance literal block language declaration

Decorater added the comment: tbh it would be nice if the entire documentation was recolored to look more 'interesting' to read. And to also have it in a way that people who lean visually can learn the info easier instead of them trying to read a giant wall of text that they may or may not

[issue26462] Patch to enhance literal block language declaration

Julien added the comment: Hi, Would you like me to also provide patches for different versions? I only provided patches for the default branch, but I'll gladly see this applied on other branches, as I often build them all. Also is a documented policy about maintaining the documentation? I

[issue26462] Patch to enhance literal block language declaration

Julien added the comment: Hi, Indentation in whatsnew/3.2 fixed. Colors in this block are clearly not perfect, but I think that's another subject. -- Added file: http://bugs.python.org/file43923/issue26462.v7.diff ___ Python tracker

[issue26462] Patch to enhance literal block language declaration

Martin Panter added the comment: One last change I think needs making to the same demo, the “code-block” needs indenting under the bullet point: * The interpreter can now be started with a quiet option, ``-q``, to prevent the copyright and version information from being displayed in the

[issue26462] Patch to enhance literal block language declaration

Julien added the comment: Hi, You're right, nice catch! Removing `python -q` from the code block demonstrating it was a bad idea. I fixed it in the v6. Thanks! -- Added file: http://bugs.python.org/file43916/issue26462.v6.diff ___ Python tracker

[issue26462] Patch to enhance literal block language declaration

Martin Panter added the comment: V5 looks pretty good to me. With your blessing of restoring the python -q example from v4 (see review), I think it is ready to commit. -- stage: patch review -> commit review ___ Python tracker

[issue26462] Patch to enhance literal block language declaration

Julien added the comment: @martin I reviewed my changes on `decimal.rst` and I now just fixing the indentation problem, so I don't change anything unrealated to fixing warnings, and don't break doctests. -- ___ Python tracker

[issue26462] Patch to enhance literal block language declaration

Julien added the comment: Here a new patch after reviewing comments on rietveld. -- Added file: http://bugs.python.org/file43892/issue26462.v5.diff ___ Python tracker

[issue26462] Patch to enhance literal block language declaration

Martin Panter added the comment: I’ve finished going over the latest patch. There are a couple of problems; see the review link. Also, why did you add the changes in Doc/library/decimal.rst? In your second patch, you removed one of these changes, but now you have added more. They seem to

[issue26462] Patch to enhance literal block language declaration

Changes by Martin Panter : Added file: http://bugs.python.org/file43885/issue26462.v4_regen.diff ___ Python tracker ___

[issue26462] Patch to enhance literal block language declaration

Martin Panter added the comment: I think generating it with Mercurial (and not using Mercurial’s Git patch format) is the best way. I just left some more notes at . -- ___ Python tracker

[issue26462] Patch to enhance literal block language declaration

Julien added the comment: Oh and, is there a proper way for me to generate a diff that rietveld can eat without someone regeneratig it? -- ___ Python tracker

[issue26462] Patch to enhance literal block language declaration

Julien added the comment: Upladed a new patch, I was working on 3.5 branch so I did not get all errors. I'm still having: WARNING: Could not parse literal_block as "ini". highlighting skipped. But it may be considered another bug: pygments ini parser can't parse ini syntax used in

[issue26462] Patch to enhance literal block language declaration

Martin Panter added the comment: With Julien’s patch applied, these are the remaining warnings: /media/disk/home/proj/python/cpython/Doc/library/configparser.rst:240: WARNING: Could not lex literal_block as "ini". Highlighting skipped.

[issue26462] Patch to enhance literal block language declaration

Changes by Martin Panter : Added file: http://bugs.python.org/file43872/issue26462.v3_regen.diff ___ Python tracker ___

[issue26462] Patch to enhance literal block language declaration

Julien added the comment: Hi, I completly missed the "review" link, sry. I reviewed comments, and I'm trying to provide an up-to-date patch that you'll hopefully won't have to doctor to make Rietveld eat it. -- Added file: http://bugs.python.org/file43847/issue26462.diff

[issue26462] Patch to enhance literal block language declaration

Zachary Ware added the comment: Hi Julien, there are still a few unanswered review comments. Check the 'review' link on 'issue26462_regen.diff' (which was your patch, I just recreated it in a format that our Rietveld review tool would accept). --

[issue26462] Patch to enhance literal block language declaration

Julien added the comment: Hi, Look like it has not been merged, is there something I can do to help with this? Bests -- ___ Python tracker ___

[issue26462] Patch to enhance literal block language declaration

Georg Brandl added the comment: Looks good now! I left a few comments on Rietveld. -- ___ Python tracker ___

[issue26462] Patch to enhance literal block language declaration

Zachary Ware added the comment: Attaching regenerated patch to coax Rietveld into accepting it for easier review. -- nosy: +zach.ware Added file: http://bugs.python.org/file42058/issue26462_regen.diff ___ Python tracker

[issue26462] Patch to enhance literal block language declaration

Julien added the comment: I revewed all my ".. code-block:: bash" and you're right (I was unaware of the existence of the "console" lexer). I changed them (reviewing them one by one) to ".. code-block:: shell-session", a synonym for ".. code-block:: console"

[issue26462] Patch to enhance literal block language declaration

Georg Brandl added the comment: Thanks for the patch! Most "bash" blocks should be "console" (since the prompt is shown). "pycon" should not be needed, since it is detected automatically. -- ___ Python tracker

[issue26462] Patch to enhance literal block language declaration

Changes by Serhiy Storchaka : -- nosy: +georg.brandl, serhiy.storchaka stage: -> patch review versions: +Python 3.6 ___ Python tracker

[issue26462] Patch to enhance literal block language declaration

New submission from Julien: Hi, As I don't like warnings, and sphinx-doc was verbose about "Could not parse literal_block as "python3". highlighting skipped.", I fixed most of them. Bonus: It's graphically better, as an example the XML block here: