Skip to content

fms-lab/julia-doc-ja

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Julia公式ドキュメント日本語化プロジェクト

概要

プログラミング言語Juliaの公式ドキュメントを日本語に翻訳するプロジェクトです.現在はJulia 1.5の翻訳作業を進めています.

作業の進め方

□ 翻訳作業の手順

/doc/src内のmarkdownファイルの翻訳作業を進めています.作業を開始する際は以下を実行して頂ければと思います.

  1. Asigneeが存在しないIssueを選び作業を宣言 (作業の衝突を防ぐため)
  2. 翻訳作業の実施
  3. PRの実施

PRがマージされるとGithub Actionsにより自動でgh-pagesが更新され,Julia公式ドキュメント日本語版にも翻訳内容(PR内容)が反映されます.

参考情報:Julia公式ドキュメント日本語版右上のEdit on Githubを押すことで,該当するmarkdownファイルにブラウザから直接アクセスすることが可能です.

□ その他作業(誤訳や表現の修正,バグ等)

適宜IssueおよびPRを実施頂けますと幸いです.

ビルド方法

mainブランチにPRがマージされる際,Github Actionsによって自動でビルドやデプロイは実行されます.もし動作確認等を理由にローカル環境でもビルドしたいケースがあれば,本リポジトリのmainブランチのルートディレクトリで以下のコマンドを実行してください.doc/src内のmarkdownファイルが変換され,doc/_build/html/ja内にHTMLファイルが生成されます.

$make docs

クレジット

先人の方々の翻訳内容を参考にさせて頂きながら本リポジトリでの作業を進めています.