[issue26106] Move licences to literal blocks
New submission from Julien: In the context of translating the documentation: I'd like to move the licence texts in https://docs.python.org/3.5/license.html to literal blocks, so they won't pollute the po files with legal (untranslatable) stuff, and it's visually more appealing (as far as it's possible for a licence text). Here is what it gives graphically when applying the patch (it's the translation, don't mind the french text): http://www.afpy.org/doc/python/3.5/license.html I also took the liberty to drop a dangling "ACCEPT", while reformating centered "titles" to real titles and building paragraphs from licence text, hope it wasn't legal stuff / part of the licence (a line before the licence mention an "accept" button ...). ---------- assignee: docs@python components: Documentation files: literal-licence.patch keywords: patch messages: 258180 nosy: docs@python, sizeof priority: normal severity: normal status: open title: Move licences to literal blocks versions: Python 3.5, Python 3.6 Added file: http://bugs.python.org/file41612/literal-licence.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue26106> _______________________________________
Ezio Melotti added the comment: Sounds like a reasonable request to me. Given the content of document, special care should be taken in reviewing the patch and making sure that nothing has gone missing. ---------- nosy: +ezio.melotti stage: -> patch review type: -> enhancement _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue26106> _______________________________________
Serhiy Storchaka added the comment: Does the |release| substitution work in literal blocks? ---------- nosy: +brett.cannon, georg.brandl, ned.deily, serhiy.storchaka _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue26106> _______________________________________
Julien added the comment: @Serhiy Well spotted, it does not work (as we can see here http://www.afpy.org/doc/python/3.5/license.html). Anyone having a better background than me in ReStructuredText have an idea ? About the review of the patch, as a human review may be fastidious, here a script to check that I did NOT modified the content of the licences themselves (still need to trust the command, but it's faster to review than the whole licence text itself): diff -w <(grep '^-' literal-licence.patch | cut -b2-) <(grep '^+' literal-licence.patch | cut -b2- | sed 's/\(^ *\)[0-8]\./\1#./g') ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue26106> _______________________________________
Georg Brandl added the comment: Since the text does need no highlighting, a parsed-literal block should work. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue26106> _______________________________________
Julien added the comment: @georg.brandl is right, a parsed-literal block should work: Does not appear in pot files, and |release| replaced: nice. I attached a new patch. ---------- Added file: http://bugs.python.org/file41641/literal-licence.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue26106> _______________________________________
Julien added the comment: And uploaded the result: http://www.afpy.org/doc/python/3.5/license.html ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue26106> _______________________________________
Roundup Robot added the comment: New changeset a04d9589e2c4 by Victor Stinner in branch '3.5': Issue #26106: doc: Move text of licenses to parsed literal block https://hg.python.org/cpython/rev/a04d9589e2c4 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue26106> _______________________________________
Roundup Robot added the comment: New changeset f2a0a4a45292 by Victor Stinner in branch '2.7': Issue #26106: doc: Move text of licenses to parsed literal block https://hg.python.org/cpython/rev/f2a0a4a45292 ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue26106> _______________________________________
STINNER Victor added the comment: Thanks for your effort of translation the doc. FYI the doc can be read at http://www.afpy.org/doc/python/ and the project (source) is at https://github.com/AFPY/python_doc_fr/ ---------- nosy: +haypo _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue26106> _______________________________________
Changes by STINNER Victor <victor.stinner@gmail.com>: ---------- resolution: -> fixed status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue26106> _______________________________________
participants (6)
-
Ezio Melotti -
Georg Brandl
-
Julien
-
Roundup Robot
-
Serhiy Storchaka
-
STINNER Victor