Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs support Chinese? #723

Closed
9468305 opened this issue Jan 17, 2019 · 7 comments
Closed

Docs support Chinese? #723

9468305 opened this issue Jan 17, 2019 · 7 comments

Comments

@9468305
Copy link

9468305 commented Jan 17, 2019

Hi guys,
Do you have plan to support Chinese docs on https://behave.readthedocs.io ?
Thanks.

@jenisys
Copy link
Member

jenisys commented Jan 17, 2019

@9468305
Do you mean a Chinese translation of the behave documentation ?!?
No, this is currently not planned
(but the same is true for other languages, like: French, German, Spanish, ...).

Are you willing to provide (and maintain) the Chinese translation of the documentation ?
But that would also mean that you are willing to maintain the Chinese pages when changes in the documentation occurs.

@9468305
Copy link
Author

9468305 commented Jan 18, 2019

@jenisys
I'm glad to do it. So could you design the rules ( divide documents structures, etc)?

@jenisys
Copy link
Member

jenisys commented Jan 19, 2019

@9468305
We basically need to insert a language level below docs, like:

BEFORE:
  behave/
    +-- docs/

AFTERWARDS: With support for multiple languages
  behave/
    +-- docs/
    |       +-- en/                        -- BEFORE: behave/docs/*.rst in English. 
    |       +-- zh-CN/ 

But let me check with readthedocs
(that will automatically rebuild the docs when the git repo changes).

@jenisys
Copy link
Member

jenisys commented Jan 20, 2019

@9468305
OK, I prepared the basics.

WORKFLOW:

  • Generate or update the messages/message-catalog under: locale/<LANG>/LC_MESSAGES/*.po
  • Fill out the message translations in the *.po files for a language
  • Build the sphinx docs for this language

WORKFLOW EXAMPLE:

# ASSUMPTION: Use the current tip of the behave repository.
# ONCE: Install sphinx-intl, etc.
pip install -U -r py.requirements/develop.txt

# -- STEP 1:
# OR: Adapt "invoke.yaml" => sphinx.languages: Add or uncomment item
invoke docs.update-translation     #< Update all languages
invoke docs.update-translation --language=<LANG>  #< Update only one language: <LANG>="zh-CN"

# -- STEP 2: Manually make the translation in the "*.po" files
# -- STEP 3: Generate sphinx-docs for this language to: "build/docs/html/<LANG>/"
invoke docs --language=<LANG>

OPEN ISSUES:

@NEOOOOOOOOOO
Copy link

@jenisys & @9468305,

I am willing to join the Chinese translation task, please let me know if there is anything I can do.

Regards.

@jenisys
Copy link
Member

jenisys commented May 26, 2019

@NEOOOOOOOOOO
Follow the workflow that is described above.
Provide the translations as pull-request: locale/<LANG>/LC_MESSAGES/*.po
Let me know if anything else is needed

@stale
Copy link

stale bot commented Nov 22, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Nov 22, 2019
@stale stale bot closed this as completed Dec 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants