[py-dev] pytest documents with Japanese translation

[Tetsuya Morimoto]

Hi Holger,

Thanks for remembering the translation! :)

> Does this also make sense to you?  If so, it'd be great if you could
> submit a pull request that reorganises pytest's docs accordingly,
> preferably starting from the current trunk.
Yes, it makes sense for me. I have experienced a similar work for
virtualenvwrapper. That might be an informative.

http://www.doughellmann.com/docs/virtualenvwrapper/index.html
http://www.doughellmann.com/docs/virtualenvwrapper/ja/index.html
https://bitbucket.org/dhellmann/virtualenvwrapper/src/e1a05e751a56/docs

> There weren't much changes
> between 2.2.3 and 2.2.4 in the doc directory, anyway.
OK! I will update the Japanese translation and submit a pull request!

> I'll take care to push the docs to pytest.org - maybe using a scheme like this:
>
>    pytest.org/VER/... # for english documentation
>    pytest.org/en/VER  # for english documentation
>    pytest.org/ja/VER  # for japanese documentation
>
> where VER is a version number and "latest" could point to the latest number.
It looks nice. I agree with you.

> that there is another error i am not sure about at the moment.
> Maybe Ronny can take a look.
I see. I will talk to Ronny later.

thanks,
Tetsuya

On Tue, May 29, 2012 at 11:13 PM, holger krekel <holger at merlinux.eu> wrote:
> Hi Tetsuya,
>
> On Mon, Apr 23, 2012 at 03:43 +0900, Tetsuya Morimoto wrote:
>> Hi Holger,
>>
>> Thanks for thinking about Japanese translation.
>
> sorry for taking a while.
>
>> > * how do the eventual URLs look like? Maybe pytest.org/latest-jp/...?
>> >  instead of pytest.org/latest/ ?
>> >  I'd definitely like to keep existing URLs working.
>> It's good idea and I suggest "latest-ja" is proper than "latest-jp"
>> since "jp" is the country code.
>
> I think the eventual URL is not a big problem.  We just need to take
> care that it is compatible with the existing scheme, i.e. allows existing
> URLs to remain valid.
>
>> > * how to organise the repository so that both EN and JP are included
>> >  (without the need to have a branch)
>> I forked original branch for Japanese translation and made named
>> branch to represent the version, but do you want to manage the
>> translation in original repository? If so, I know Sphinx has i18n
>> feature using gettext since 1.1. Is this useful for your purpose?
>> http://sphinx.pocoo.org/latest/intl.html
>
> I think what we need is something along those lines:
>
> http://mark-story.com/posts/view/creating-multi-language-documentation-with-sphinx
>
> Does this also make sense to you?  If so, it'd be great if you could
> submit a pull request that reorganises pytest's docs accordingly,
> preferably starting from the current trunk.  There weren't much changes
> between 2.2.3 and 2.2.4 in the doc directory, anyway.
>
> I think we'd end up with something like:
>
>    pytest/
>        doc/
>            en/
>                # current english files and dirs
>            ja/
>                # current japanese files and dirs
>
> I'll take care to push the docs to pytest.org - maybe using a scheme like this:
>
>    pytest.org/VER/... # for english documentation
>    pytest.org/en/VER  # for english documentation
>    pytest.org/ja/VER  # for japanese documentation
>
> where VER is a version number and "latest" could point to the latest number.
>
>> > * do we need to do anything special wrt to the examples and their
>> >  generation? (we use a tool called 'regendoc' written by ronny which
>> >  regenerates the example outputs)
>> I used original example code with document, so the example's version
>> are "pytest-2.2.2"? And then, I tried to run regen (make regen), but I
>> got an error. It seems regenerating has an encoding issue.
>>
>> (sphinx)$ make regen
>> PYTHONDONTWRITEBYTECODE=1 COLUMNS=76 regendoc --update *.txt */*.txt
>> ===== checking apiref.txt =====
>> Traceback (most recent call last):
>>   File "/Users/t2y/.virtualenvs/sphinx/bin/regendoc", line 9, in <module>
>>     load_entry_point('RegenDoc==0.2.dev1', 'console_scripts', 'regendoc')()
>>   File "/Users/t2y/work/python/regendoc/regendoc.py", line 201, in main
>>     return _main(options.files, should_update=options.update)
>>   File "/Users/t2y/work/python/regendoc/regendoc.py", line 196, in _main
>>     path.write(corrected)
>>   File "/Users/t2y/.virtualenvs/sphinx/lib/python2.7/site-packages/py/_path/local.py",
>> line 385, in write
>>     data = py.builtin._totext(data, sys.getdefaultencoding())
>> UnicodeDecodeError: 'ascii' codec can't decode byte 0xe3 in position
>> 22: ordinal not in range(128)
>> make: *** [regen] Error 1
>
> One problem is that regendoc.py:196 should call "path.write(corrected,
> 'wb')" in order to write out bytes and inhibit conversions. But after
> that there is another error i am not sure about at the moment.
> Maybe Ronny can take a look.
>
> best,
> holger
>
>> thanks,
>> Tetsuya
>>
>> On Fri, Apr 20, 2012 at 12:45 PM, holger krekel <holger at merlinux.eu> wrote:
>> > Hi Tetsuya,
>> >
>> > thanks for your work already!
>> >
>> > i guess we need to work a bit to have both language versions
>> > generated.  I haven't looked at your branch yet but i guess
>> > we need to solve a few issues:
>> >
>> > * how do the eventual URLs look like? Maybe pytest.org/latest-jp/...?
>> >  instead of pytest.org/latest/ ?
>> >  I'd definitely like to keep existing URLs working.
>> >
>> > * how to organise the repository so that both EN and JP are included
>> >  (without the need to have a branch)
>> >
>> > * do we need to do anything special wrt to the examples and their
>> >  generation? (we use a tool called 'regendoc' written by ronny which
>> >  regenerates the example outputs)
>> >
>> > best,
>> > holger
>> >
>> >
>> > On Mon, Apr 16, 2012 at 16:24 +0900, Tetsuya Morimoto wrote:
>> >> Hi,
>> >>
>> >> I finished translating pytest documents English to Japanese. My
>> >> repository is below and I made the named branch "2.2.3-ja" for
>> >> translating docs.
>> >>
>> >> https://bitbucket.org/t2y/pytest-ja
>> >>
>> >> I would like to publish this Japanese translation on pytest.org with
>> >> some ways. But, I don't know it's possible or not, and how to deploy
>> >> the current docs. I think putting original and translated docs
>> >> separately is easy deployment to avoid some conflicts. Of course,
>> >> other suggestions are welcome.
>> >>
>> >> Additionally, I can maintain Japanese docs in the future. So, I can
>> >> work by myself if you give me needed permission.
>> >>
>> >> thanks,
>> >> Tetsuya
>> >> _______________________________________________
>> >> py-dev mailing list
>> >> py-dev at codespeak.net
>> >> http://codespeak.net/mailman/listinfo/py-dev
>> >>
>> _______________________________________________
>> py-dev mailing list
>> py-dev at codespeak.net
>> http://codespeak.net/mailman/listinfo/py-dev