Skip to content

Commit

Permalink
docs: add translation
Browse files Browse the repository at this point in the history
  • Loading branch information
fan-ziqi committed Jul 4, 2024
1 parent ecc3484 commit 671ac4e
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 8 deletions.
8 changes: 1 addition & 7 deletions .github/workflows/sync-and-translate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools polib==1.2.0 openai==v1.3.6 python-dotenv==1.0.0 pytest==8.2.2 sphinx-intl sphinx-book-theme==1.0.1 myst-parser sphinxcontrib-bibtex==2.5.0 autodocsumm sphinx-copybutton sphinx-icon sphinx_design sphinxemoji numpy matplotlib warp-lang gymnasium
pip install setuptools polib==1.2.0 openai==v1.3.6 python-dotenv==1.0.0 pytest==8.2.2 sphinx-intl sphinx-book-theme==1.0.1 myst-parser sphinxcontrib-bibtex==2.5.0 autodocsumm sphinx-copybutton sphinx-icon sphinx_design sphinxemoji numpy matplotlib warp-lang gymnasium sphinx-comments
- name: Generate gettext
run: |
Expand All @@ -52,12 +52,6 @@ jobs:
sphinx-intl update -p _build/gettext -l zh_CN
popd
- name: show po and pot files
run: |
ls docs
ls docs/_build/gettext
ls docs/locale/zh_CN/LC_MESSAGES
- name: Translate using custom script
run: |
pushd docs
Expand Down
9 changes: 8 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@
"sphinxcontrib.icon",
"sphinx_copybutton",
"sphinx_design",
"sphinx_comments",
]

# mathjax hacks
Expand Down Expand Up @@ -257,4 +258,10 @@ def setup(app):
app.connect("autodoc-skip-member", skip_member)

locale_dirs = ['locale/'] # path is example but recommended.
gettext_compact = False # optional.
gettext_compact = False # optional.

comments_config = {
"utterances": {
"repo": "fan-ziqi/IsaacLab",
}
}
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ Table of Contents
source/setup/sample
source/setup/template
source/setup/faq
source/setup/translation

.. toctree::
:maxdepth: 2
Expand Down
6 changes: 6 additions & 0 deletions docs/source/setup/translation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
About Translation
=========================

Translator: `fan-ziqi <https://github.com/fan-ziqi>`__

Translation will be updated on `fan-ziqi/IsaacLab <https://github.com/fan-ziqi/IsaacLab>`__

0 comments on commit 671ac4e

Please sign in to comment.