Mailman 3 October 2020 - Doc-SIG

Status for Transifex-based translations
by Maciek Olko Aug. 1, 2021

Aug. 1, 2021

Hello, I want to share with you a small script that displays translation status for language switcher for Transifex-based translations. The script is using Transifex API [1] and requires Transifex API token. https://github.com/m-aciek/python-docs-pl-status/blob/master/checkstatus.py It generates README.md file with status. Currently, for Polish translation it is 5.17%. Regards, Maciej [1] https://docs.transifex.com/api/resources [2] https://github.com/m-aciek/python-docs-pl-status

3 6

Re: [Doc-SIG] Fwd: Getting translations from pootle.python.org
by Ernest W. Durbin III Nov. 9, 2020

Nov. 9, 2020

All the PO files I could find are available in a tarball at https://legacy.python.org/pootle-pos.tgz <http://legacy.python.org/pootle-pos.tgz> See below signature for the README regarding pootle. Seems it was an abandoned Google Summer of Code project. If anything beyond the POs are necessary please let me know and I can grab it for you. -Ernest W. Durbin III This is the python.org instance of Pootle reachable from pootle.python.org. It has been set up as part of the Google Summer of Code by Robert Lehmann with Martin von Loewis. Pootle runs via Apache's mod_wsgi (cf. pootle/wsgi.py). IF ANYTHING BREAKS, PLEASE CONTACT GSOC(a)ROBERTLEHMANN.DE. Directory structure: + sphinx-i18n: Sphinx fork with internationalization features + pootle: Pootle fork + translate: Translate Toolkit fork + Doc: checkout of py3k documentation with locale_dirs set to `mo' and `sphinx.ext.oldcmarkup' loaded + newsphinx: virtual environment with sphinx-i18n installed + locale: exchange directory for Pootle and Sphinx; contains one directory per project, and one directory per language in turn (with .POT files ending up in templates/). + mo: stored MO files for individual languages in a folder called LC_MESSAGES for compatibility with gettext. + html: localized HTML builds of the py3k documentation + migr: artifacts of the conversion from SQLite to Postgres Previously, the default Apache user (`nobody') needed access to the locale/ and pootle/dbs/ directories for Pootle to run smoothly. Apache WSGI now drops into user `pootle' correctly. Scripts: + update-mo: build MO files from locale/python/*/*.po to mo/*/LC_MESSAGES/*.mo (requires msgfmt) + update-software: update the checkouts and install packages where neccessary (in virtualenv, requires hg/git) + update-templates: build POT files from Doc/ to locale/python/templates/*.po (requires Sphinx with i18n support, automatically updates checkout) + update-intl: build HTML docs from locale/ translations and Doc/ sources Cronjobs: + daily at 7pm: update-mo and update-intl (ie. a translated build from Pootle sources) with logging to ~/html/build.log Security Considerations: + Apache runs the WSGI script ~/pootle/wsgi.py as user `pootle' and serves ~/pootle/html statically. -- http://gsoc.robertlehmann.de/ On October 27, 2020 at 8:29:52 PM, Julien Palard (julien(a)palard.fr) wrote: Hi Ernest, I'm forwarding this to you as you may know, it's from doc-sig, maybe reply on the ML if you have info. Bests. -------- Forwarded Message -------- Subject: [Doc-SIG] Getting translations from pootle.python.org Date: Wed, 28 Oct 2020 00:22:22 +0100 From: Maciek Olko <maciej.olko(a)gmail.com> Reply-To: Maciek Olko <maciej.olko(a)gmail.com> To: doc-sig(a)python.org Hi, according to WebArchive, pootle.python.org <http://pootle.python.org> hosted Polish translation of documentation finished in 12% for Python 3 [1]. This Pootle instance was shut down in early 2012 [2]. It would be great to get access to those resources and maybe be able to upload this translation as translation memory for recent versions of documentation. Do you have an idea if there is some kind of back-up of work done on Pootle? Who could I contact further to ask? There's no information about back-up in issue tracing the disabling of Python Pootle. [2] Kind regards, Maciej Olko [1] https://web.archive.org/web/20131226143301/http://pootle.python.org/pootle [2] https://bugs.python.org/issue13663

2 8

Getting translations from pootle.python.org
by Maciek Olko Oct. 27, 2020

Oct. 27, 2020

Hi, according to WebArchive, pootle.python.org hosted Polish translation of documentation finished in 12% for Python 3 [1]. This Pootle instance was shut down in early 2012 [2]. It would be great to get access to those resources and maybe be able to upload this translation as translation memory for recent versions of documentation. Do you have an idea if there is some kind of back-up of work done on Pootle? Who could I contact further to ask? There's no information about back-up in issue tracing the disabling of Python Pootle. [2] Kind regards, Maciej Olko [1] https://web.archive.org/web/20131226143301/http://pootle.python.org/pootle [2] https://bugs.python.org/issue13663

1 0

Broken link on documentation header
by tomo cocoa Oct. 19, 2020

Oct. 19, 2020

Hi Julien, perhaps can you understand the reasons that the link "Documentation" on the head of the top page leads 404 pages? [image: Screen Shot 2020-09-11 at 22.10.37.png] This trouble occurs all language documentation except English. -- class Cocoatomo: name = 'cocoatomo' email_address = 'cocoatomo77(a)gmail.com' twitter_id = '@cocoatomo'

2 2

PEP257 Suggestion : semicolons use for attribute docstrings
by Erik Aronesty Oct. 16, 2020

Oct. 16, 2020

I wasn't sure where to post this, maybe a mailing list? PEP-257: String literals occurring immediately after a simple assignment at the top level of a module, class, or __init__ method are called "attribute docstrings". ```python class Foo: attr = 1 """PEP for doscstrings on attrs is that it comes after. So this is for 'attr'""" some_other_attr = 'is this the one we're documenting?' ``` A semicolon is a natural delimiter for single-line attribute docstrings. ```python class Foo: # pylint: disable=multiple-statements attr = 1; """PEP for doscstrings on attrs is that it comes after. So this is for 'attr'""" some_other_attr = 'is this the one we're documenting?' ``` The PEP style is obviously unclear. Docstrings, in general, are hard to format well... the simplest rule is that they must be visually linked to the thing they are documenting. Fortunately, the semicolon allows us to visually connect a single-line docstring to its attribute -as long as the line-length is short. As an alternative a comment or something could provide visual cues, and if this is the standard, it should be added to the PEP on docstrings. ```python class Foo: attr = 1; """PEP for doscstrings on attrs is that it comes after. So this is for 'attr'""" # ----- some_other_attr = 'is this the one we're documenting?' ```

2 1