[OpenStack-docs] [Openstack-i18n] Translating RST source with Sphinx builds

Andreas Jaeger aj at suse.com
Fri Feb 6 10:04:57 UTC 2015


On 02/06/2015 08:30 AM, Ying Chun Guo wrote:
> Thanks, Anne.
> I finally generate HTML pages in English and in Chinese.
> 
> Do we want to use the same command (i.e. tox) to build different
> language documents?
> I use "sphinx-build -D language='zh_CN'" to generate Chinese document.
> If we want to use tox to build translated documents, tox.ini needs to be
> modified a little.

We currently use tox to build translated documents and should continue
doing so.

For Docbook, we use doc-tools-check-languages.conf.

I suggest to create a new script - or enhance the existing one - that
gets called from tox.ini and uses doc-tools-check-languages.conf to
configure which books and which languages to build,

Andreas
> 
> Best regards
> Ying Chun Guo (Daisy)
> 
> 
> Anne Gentle <annegentle at justwriteclick.com> wrote on 2015/02/06 07:29:45:
> 
>> From: Anne Gentle <annegentle at justwriteclick.com>
>> To: Ying Chun Guo/China/IBM at IBMCN
>> Cc: Andreas Jaeger <aj at suse.com>, "openstack-
>> docs at lists.openstack.org" <openstack-docs at lists.openstack.org>,
>> "openstack-i18n at lists.openstack.org" <openstack-i18n at lists.openstack.org>
>> Date: 2015/02/06 07:30
>> Subject: Re: [OpenStack-docs] [Openstack-i18n] Translating RST
>> source with Sphinx builds
>>
>> Hi Daisy,
>>
>> Once this merges:
>>
>> https://review.openstack.org/#/c/152690/
>>
>> You can run tox -e docs to see the Html output. Maybe you can test
>> that patch to make sure it works for you?
>>
>> I've got full instructions here that I tested on Mac and Laurel
>> tested on Windows:
>>
>> https://wiki.openstack.org/wiki/Documentation/Migrate
>>
>> Let us know if you have trouble.
>>
>> Anne Gentle
>> Content Stacker
>> anne at openstack.org
>>
>>
>> On Feb 5, 2015, at 5:17 PM, Ying Chun Guo <guoyingc at cn.ibm.com> wrote:
> 
>> Hello,
>>
>> I met with problem to build html documents.
>> There are many opinions to set.
>> I want to understand how you would build English HTML document.
>> Then I could follow the similar steps to build translated document.
>>
>> Any links sharing with me?
>>
>> Best regards
>> Ying Chun Guo (Daisy)
>>
>>
>> <graycol.gif>Andreas Jaeger ---2015/02/04 04:02:34---On 02/03/2015
>> 03:22 PM, Ying Chun Guo wrote: > Anne,
>>
>> From: Andreas Jaeger <aj at suse.com>
>> To: Ying Chun Guo/China/IBM at IBMCN, Anne Gentle
> <annegentle at justwriteclick.com>
>> Cc: "openstack-i18n at lists.openstack.org"
> <openstack-i18n at lists.openstack.org
>> >, "openstack-docs at lists.openstack.org"
> <openstack-docs at lists.openstack.org>
>> Date: 2015/02/04 04:02
>> Subject: Re: [OpenStack-docs] [Openstack-i18n] Translating RST
>> source with Sphinx builds
>>
>>
>>
>> On 02/03/2015 03:22 PM, Ying Chun Guo wrote:
>> > Anne,
>> >
>> > I would take a look at this new format, and see how it could fit to our
>> > translation process.
>>
>> Daisy,
>>
>> I did a little playing around and want to share what I did:
>>
>> 1) To build the pot files:
>>
>> $ sphinx-build -b gettext doc/playground-user-guide/source/
>> doc/playground-user-guide/locale/
>>
>> This creates a file per directory or top-level file.
>>
>> 2) so, next i run "msgcat *.pot > playground-user-guide.pot" to create a
>> single pot file
>>
>> 3) I would upload the pot file
>>
>> 4) We can download it again
>>
>> 5) And then it's running msgmerge to merge the content back to the
>> multiple files.
>>
>> We really should have only one file per book - otherwise we get
>> duplicated "index.pot" files from each book and have multiple books in a
>> repo.
>>
>> I haven't had time to test all of this together properly and then create
>> some simple script. If you can tell me how to do it properly, I can help
>> with enhancing the infra scripts so that this is done automatically -
>> but I'm also happy to review any patches and answer questions ;)
>>
>> Thanks
>> Andreas
>> --
>> Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
>>  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>>   GF: Felix Imendörffer, Jane Smithard, Jennifer Guild, Dilip Upmanyu,
>>       Graham Norton, HRB 21284 (AG Nürnberg)
>>    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126
>>
> 
> 
> _______________________________________________
> Openstack-i18n mailing list
> Openstack-i18n at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-i18n
> 


-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Felix Imendörffer, Jane Smithard, Jennifer Guild, Dilip Upmanyu,
       Graham Norton, HRB 21284 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126




More information about the OpenStack-docs mailing list