Qiskit Document 翻訳について ～ Contribution

Qiskit Documentについて

• Qiskitの公式ドキュメントはGithubで管理されている。
  • ドキュメント例
    Circuit Tutorials — Qiskit 0.19.6 ドキュメント
  • 該当のGithub
    qiskit-tutorials/tutorials/circuits at master · Qiskit/qiskit-tutorials · GitHub
• Githubでは Jupyter Notebook で管理されている。
• Notebook はSphinxに変換され、reStructuredText 形式になってから公開される。

翻訳での記法について

• 翻訳プロジェクトは以下で管理されている。
  • GitHub - qiskit-community/qiskit-translations: Home of Qiskit documentation translations
• 翻訳は、reStructuredTextに変換された英文を訳すことになる。
• そのため reStruecturedText記法の基本程度は知っておく必要がある。

reStruecturedText記法

• 記法等は以下が詳しい。
  • reStructuredText入門 — Sphinx 4.0.0+/70d521ad9 ドキュメント

翻訳作業について

• 翻訳作業は基本的にCrowdinで完結する。
• しかし、プレビュー機能がないため、翻訳語の記法が正しいかをその場で確認することが出来ない。
• 記法を確認するには、たとえばVSCodeを使う方法がある。

VSCodeでの記法確認

• VSCodeとPython（3.7以降）をインストールする。Pythonのパスを環境変数（PATH）に追加する。
  • https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites
• 拡張機能「reStructuredText」をインストールする。
  
• .rst でファイルを作成し、Ctrl+Shift+r でプレビュー画面を開ける。
• 参考
  • https://www.pine4.net/Memo2/Article/Archive/reStructuredText-extension-for-Visual-Studio-Code-is-awesome