Chinese localization of Sphinx websit and docs

74 views
Skip to first unread message

Xiuyu Li

unread,
Aug 13, 2020, 8:22:03 AM8/13/20
to sphinx-dev
Hello!
We want to optimize the localization of Sphinx website and documents in Chinese and have found some problems. So we seek for help here: 

1. We found an existing Chinese Sphinx website. (https://www.sphinx.org.cn/index.htmlBut there are many places and docs that have not been localized, and there is no Chinese-English switch button on the website. Is this website the official Chinese Sphinx website?
2. We saw a link to a Sphinx document in Chinese on Github(in Documentation pages for each languages), but when we clicked on it, it didn't exist. (https://www.sphinx-doc.org/en/master/zh_CN)
3. We want to optimize the Chinese website and documents of Sphinx and complete the entire localization. Can Sphinx prove the contribution of our team? What form of the proof can we get?

Thanks for your help.
Melia Lee 

Komiya Takeshi

unread,
Aug 13, 2020, 9:14:18 AM8/13/20
to sphin...@googlegroups.com
Hi,

Thank you for mailing.

>1. We found an existing Chinese Sphinx website. (https://www.sphinx.org.cn/index.html) But there are many places and docs that have not been localized, and there is no Chinese-English switch button on the website. Is this website the official Chinese Sphinx website?

No, this is not an official website.

>2. We saw a link to a Sphinx document in Chinese on Github(in Documentation pages for each languages), but when we clicked on it, it didn't exist. (https://www.sphinx-doc.org/en/master/zh_CN)

Yes. We've not enabled the Chinese version of sphinx official site yet.

>3. We want to optimize the Chinese website and documents of Sphinx and complete the entire localization. Can Sphinx prove the contribution of our team? What form of the proof can we get?

We've managed all translations of our website in transifex. So please
join our team on transifex and translate the document into Chinese.
Then we'll publish the Chinese version docs to the internet. At
present, it was translated only 5% of document. We're very welcome all
your help :-)
https://www.transifex.com/sphinx-doc/sphinx-doc/dashboard/

Thanks,
Takeshi KOMIYA

2020年8月13日(木) 21:22 Xiuyu Li <lixi...@163.com>:
> --
> You received this message because you are subscribed to the Google Groups "sphinx-dev" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-dev+...@googlegroups.com.
> To view this discussion on the web, visit https://groups.google.com/d/msgid/sphinx-dev/2aabc1ba-71e0-4cd0-9cc5-0c42f83f6002o%40googlegroups.com.

Xiuyu Li

unread,
Aug 14, 2020, 2:18:09 AM8/14/20
to sphinx-dev
Thank you for your reply. 

We are a professional localization team from Computer Aided Translation program of Peking University. We have some specific ideas and questions about the Chinese website of Sphinx. We hope to get your reply and help:

1. We would like to know the reason why there is no official Chinese website yet. If there is no Chinese official website at all, we are willing to establish one in line with Chinese reading habits based on the English official website. We hope that we can submit this request to you through Github. If the  Chinese official website has already been done but not finished, we hope to join the localization team to optimize (and release) the existing Chinese official website.

2. We wonder that if you can provide relevant materials to help us localize the website. We need the source code of the website and all the texts. Given that we have participated in the localization of Apache website, we have some expeirence. So it would be great that you can make open source of the website on Github (Here is the open source link of Apache  for reference: https://github.com/apache/shardingsphere-doc ).

3. If you agree with us to join the team and localize the Website in Chinese, we hope to receive your email or other forms of reply after our localization to prove our contribution. 

Thank you very much.
Melia Lee

Komiya Takeshi

unread,
Aug 14, 2020, 4:15:24 AM8/14/20
to sphin...@googlegroups.com
> 1. We would like to know the reason why there is no official Chinese website yet. If there is no Chinese official website at all, we are willing to establish one in line with Chinese reading habits based on the English official website. We hope that we can submit this request to you through Github. If the Chinese official website has already been done but not finished, we hope to join the localization team to optimize (and release) the existing Chinese official website.

Our document was translated into Chinese by about 5%. I think it's not
enough to publish on the internet.

> 2. We wonder that if you can provide relevant materials to help us localize the website. We need the source code of the website and all the texts. Given that we have participated in the localization of Apache website, we have some expeirence. So it would be great that you can make open source of the website on Github (Here is the open source link of Apache for reference: https://github.com/apache/shardingsphere-doc ).

As I commented at last mail, we're using transifex.com to manage all
translation messages including Chinese. So please join our project on
transifex.com and translate messages.

> 3. If you agree with us to join the team and localize the Website in Chinese, we hope to receive your email or other forms of reply after our localization to prove our contribution.

Of course, I'm okay to send a mail to you. But I don't know what do
you expect of me. What I should do? How do I "prove" the contribution?

Thanks,
Takeshi KOMIYA
> To view this discussion on the web, visit https://groups.google.com/d/msgid/sphinx-dev/e533e81f-6086-46fd-a30a-b9051a4ee6aan%40googlegroups.com.

Xiuyu Li

unread,
Aug 14, 2020, 6:42:46 AM8/14/20
to sphinx-dev
We are sorry that maybe we didn't express our ideas clearly.

We do have seen the  translation messages on   https://www.transifex.com/sphinx-doc/sphinx-doc/dashboard/  , including the translation of Sphinx core and documents. But we didn't find the translation of the web UI, is it Sphinx-doc 2? 

Meanwhile, we think the current UI interface can be further optimized. Could we make changes to the UI, such as adding a language-switch button to the English official website and designing the UI of the Chinese page? This is what we want to do and we apply for your approve. If you approve, we can  pull request to you on Github and after we finish the work, we can put the Chinese version of sphinx site on the link  https://www.sphinx-doc.org/en/master/zh_CN.

Thanks for your time.
Melia Lee

Komiya Takeshi

unread,
Aug 14, 2020, 7:29:09 AM8/14/20
to sphin...@googlegroups.com
> We do have seen the translation messages on https://www.transifex.com/sphinx-doc/sphinx-doc/dashboard/ , including the translation of Sphinx core and documents. But we didn't find the translation of the web UI, is it Sphinx-doc 2?

The sphinx-doc project contains it. Please choose "sphinx-doc" from
the sidebar. Then you'll see the list of languages. Next, search
"Chinese" and put a "translate" button on the right. After that,
please search a message catalog named as "sphinx". It is a message
catalog for Web UI. (Or some messages might be a part of Sphinx core.
If so, please search "sphinx.pot" from sphinx project".)

> Meanwhile, we think the current UI interface can be further optimized. Could we make changes to the UI, such as adding a language-switch button to the English official website and designing the UI of the Chinese page? This is what we want to do and we apply for your approve. If you approve, we can pull request to you on Github and after we finish the work, we can put the Chinese version of sphinx site on the link https://www.sphinx-doc.org/en/master/zh_CN.

It is easy to add Chinese to the list of language-switcher. It's a
feature of readthedocs. So I can enable it on console basically. No
pull request needed to do that. But, as I commented above, it is not
still translated mostly yet. So it should be translated first to
enable on the menu.

About other changes, please send a pull request to the Sphinx theme of
our website. You can see it in here:
https://github.com/sphinx-doc/sphinx/tree/3.x/doc/_themes/sphinx13

Note: You need to change the theme whole of all languages. There is no
way to change only for arbitrary language. So you need to change the
theme in English, first. After that, translate it to Chinese on
transifex.com.
> To view this discussion on the web, visit https://groups.google.com/d/msgid/sphinx-dev/5f938fa1-7586-423c-aefd-8fd2e66dd947n%40googlegroups.com.

Takayuki SHIMIZUKAWA

unread,
Aug 29, 2020, 12:13:33 AM8/29/20
to sphinx-dev
Hi,

Now zh_CN translation on sphinx-doc.org is automatically imported from Transifex.
 
Best,
2020年8月14日金曜日 20:29:09 UTC+9 i.tk...@gmail.com:

李秀宇

unread,
Aug 29, 2020, 11:47:46 AM8/29/20
to sphin...@googlegroups.com, sphin...@googlegroups.com

Xiuyu Li

unread,
Sep 3, 2020, 6:00:36 AM9/3/20
to sphinx-dev
Hi, 

as you can see on Transifex, we are working on the Chinese translation task(https://www.transifex.com/sphinx-doc/sphinx-doc/language/zh_CN/), which we expect to complete on 6th September.  So, I would like to communicate with you about the following localization issues of next step:

1. How to review the translation after we finish it and how long will it take you to finish reviewing our translation?  Plus, when will the latest Chinese version of Sphinx and  software be released? (We have completed the translation of Sphinx core at herehttps://www.transifex.com/sphinx-doc/sphinx-1/language/zh_CN/).  Since we are doing a project of school about Sphinx localization, we hope to see the official website and software of  Chinese update with our translation as soon as possible.

2. In addition, we would like to learn from your team's process for localizing Sphinx. So, it would be great if you can tell me more about your work. Such as why you chose to use the transifex tool to do the localization; how do you think about transifex as a CAT tool; what else did you do except distributing translation tasks?

Thanks for your time.
Melia

Xiuyu Li

unread,
Sep 4, 2020, 3:13:07 AM9/4/20
to sphinx-dev
Hi, 

as you can see on Transifex, we are working on the Chinese translation task(https://www.transifex.com/sphinx-doc/sphinx-doc/language/zh_CN/), which we expect to complete on 6th September.  So, I would like to communicate with you about the following localization issues of next step:

1. How to review the translation after we finish it and how long will it take you to finish reviewing our translation?  Plus, when will the latest Chinese version of Sphinx and  software be released? (We have completed the translation of Sphinx core at herehttps://www.transifex.com/sphinx-doc/sphinx-1/language/zh_CN/).  Since we are doing a project of school about Sphinx localization, we hope to see the official website and software of  Chinese update with our translation as soon as possible.

2. In addition, we would like to learn from your team's process for localizing Sphinx. So, it would be great if you can tell me more about your work. Such as why you chose to use the transifex tool to do the localization; how do you think about transifex as a CAT tool; what else did you do except distributing translation tasks?
Thanks for your time.
Melia
在2020年8月14日星期五 UTC+8 下午7:29:09<i.tk...@gmail.com> 写道:

Komiya Takeshi

unread,
Sep 4, 2020, 8:51:23 PM9/4/20
to sphin...@googlegroups.com
Hi Melia,

Thank you for your great work!

>1. How to review the translation after we finish it and how long will it take you to finish reviewing our translation?

At present, reviewing process has not been working. At least, current
maintainers does not read Chinese at all. So we can't review your
translations. Please call for review at here and the sphinx-users
list. Somebody who can read Chinese might review your translations.

>Plus, when will the latest Chinese version of Sphinx and software be released? (We have completed the translation of Sphinx core at herehttps://www.transifex.com/sphinx-doc/sphinx-1/language/zh_CN/).

We adopted the annual release model. So it will be released next
Spring (Apr 2021).

>2. In addition, we would like to learn from your team's process for localizing Sphinx. So, it would be great if you can tell me more about your work. Such as why you chose to use the transifex tool to do the localization; how do you think about transifex as a CAT tool; what else did you do except distributing translation tasks?

Sorry, I don't know. It was already used when I joined this project.
shimizukawa might know something about it.

Thanks,
Takeshi KOMIYA

2020年9月4日(金) 16:13 Xiuyu Li <lixi...@163.com>:
> To view this discussion on the web, visit https://groups.google.com/d/msgid/sphinx-dev/8c10a667-01cf-4a7c-9aeb-b74c438483ecn%40googlegroups.com.
Reply all
Reply to author
Forward
0 new messages