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

The document supports en and ja. #372

Merged
merged 11 commits into from
Jun 10, 2024
Merged

The document supports en and ja. #372

merged 11 commits into from
Jun 10, 2024

Conversation

tkokada
Copy link
Collaborator

@tkokada tkokada commented Jun 6, 2024

The PR contains followings:

  • Update the api reference and locale files (this update replace sooo many files in docs/source/api_reference and docs/source/locale directories).
  • Support english and japanese on github pages.
  • Add naive html to redirect to japanese page.
  • Add naive html to add a button to select languages.

As mentioned above, htmls should be modified in future.
But the PR can support english and japanese by the button.
Most of the api reference generation are automated, but the localization process is sitll needed to modify by hands.
For example, if you update the docstring, followings are the instructions to update the api reference:

path/to/aiaccel/repo

$ sphinx-apidoc -f -o docs/source/api_reference aiaccel

$ cd docs

$ make gettext

$ sphinx-intl update -p build/gettext -l en -l ja

This generates localization files in docs/source/locale directory.
The instruction commands update (delete) the files if docs/source/locale includes translated files.

@tkokada tkokada requested a review from yoshipon June 6, 2024 06:52
Copy link
Collaborator

@yoshipon yoshipon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ありがとうございます!

@yoshipon yoshipon merged commit a9b8a17 into main Jun 10, 2024
15 checks passed
@yoshipon yoshipon deleted the feature/gh-pages branch June 10, 2024 05:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants