Sphinx  を用いた  Biopython  チュートリアル翻訳 @kozo_ni
発表の要旨 <ul><li>増田さんによる Biopython のドキュメント和訳に少なからず影響を受けたので自分もやってみようと思う </li></ul><ul><li>Sphinx という Python 製ドキュメント生成ツールの評判が良い...
発表の流れ <ul><li>Biopython とは </li></ul><ul><li>Sphinx とは </li></ul><ul><li>Github から和訳の clone 取ってきて Sphinx で make して html 生成...
<ul><li>配列情報の操作,パース </li></ul><ul><ul><li>相補鎖,転写,翻訳 </li></ul></ul><ul><ul><li>Parser (FASTA, GenBank, SwissProt, BLAST, F...
Biopython  の日本語ドキュメント <ul><li>増田泰,石田貴士,坂井俊哉 氏による チュートリアル,クックブックの和訳  (GIW2004  サテライト  BOF) </li></ul><ul><li>増田氏ら作成時以降の Bio...
<ul><li>reStructuredText ファイルから HTML, LaTeX, PDF, etc  ファイルを生成するスクリプト集 </li></ul><ul><li>特徴 </li></ul><ul><ul><li>ブラウズしやすい...
Sphinx について頂いた質問 <ul><li>Javadoc のようなものか  ? </li></ul><ul><ul><li>否.コードから API ドキュメントを生成するようなものではない. </li></ul></ul><ul><ul...
ドキュメント和訳作業の流れ <ul><li>Sphinx をインストール </li></ul><ul><li>Github で biopython-tutorial-ja を folk </li></ul><ul><li>git clone <...
1-3, 6-8 の説明は割愛
例) chapter2.rst 元の英文のコメントとして書いておく 章,説 ごとの区切りの書き方 その下に和訳を書く ソースを書くときはこのように書く あとはプロジェクトのトップディレクトリで make html と打つと _build/htm...
Github における Biopython 情報 <ul><li>Biopython のソース </li></ul><ul><ul><li>http://github.com/biopython/biopython </li></ul></ul...
私見 (Biopython と Bioconductor[R]) <ul><li>R の方が適していると思われる作業がチュートリアル中に存在 </li></ul><ul><li>上記のような作業の場合 R とのインタフェース関数を用意し R を...
Upcoming SlideShare
Loading in...5
×

Sphinxを用いたBiopythonチュートリアル翻訳

1,906

Published on

第12回オープンバイオ研究会発表資料
http://open-bio.jp/?meeting12

Published in: Education
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total Views
1,906
On Slideshare
0
From Embeds
0
Number of Embeds
1
Actions
Shares
0
Downloads
8
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Sphinxを用いたBiopythonチュートリアル翻訳

  1. 1. Sphinx を用いた Biopython チュートリアル翻訳 @kozo_ni
  2. 2. 発表の要旨 <ul><li>増田さんによる Biopython のドキュメント和訳に少なからず影響を受けたので自分もやってみようと思う </li></ul><ul><li>Sphinx という Python 製ドキュメント生成ツールの評判が良いらしいのでこれを活用 </li></ul><ul><li>Github で管理をしているので,もし興味を持たれた方は一緒にやりませんか ? </li></ul>
  3. 3. 発表の流れ <ul><li>Biopython とは </li></ul><ul><li>Sphinx とは </li></ul><ul><li>Github から和訳の clone 取ってきて Sphinx で make して html 生成する方法の説明 </li></ul>
  4. 4. <ul><li>配列情報の操作,パース </li></ul><ul><ul><li>相補鎖,転写,翻訳 </li></ul></ul><ul><ul><li>Parser (FASTA, GenBank, SwissProt, BLAST, FASTQ, etc) </li></ul></ul><ul><ul><li>Alignment Tool とのインタフェース (ClustalW, EMBOSS, etc) </li></ul></ul><ul><li>DB 情報の取得,パース </li></ul><ul><ul><li>NCBI(PubMed and Medline, GEO, UniGene) </li></ul></ul><ul><ul><li>Swiss-Plot, ExPASy </li></ul></ul><ul><li>蛋白質構造情報パース </li></ul><ul><ul><li>PDB </li></ul></ul>
  5. 5. Biopython の日本語ドキュメント <ul><li>増田泰,石田貴士,坂井俊哉 氏による チュートリアル,クックブックの和訳 (GIW2004 サテライト BOF) </li></ul><ul><li>増田氏ら作成時以降の Biopython ドキュメントの変化 </li></ul><ul><ul><li>次世代シーケンサ用ファイルの取り扱い </li></ul></ul><ul><ul><li>GenomeDiagram </li></ul></ul><ul><ul><li>[Pritchard et al. (2006), Bioinformatics 22 616-617] </li></ul></ul><ul><ul><ul><li>ゲノム情報可視化パッケージ </li></ul></ul></ul><ul><ul><li>Etc… </li></ul></ul>
  6. 6. <ul><li>reStructuredText ファイルから HTML, LaTeX, PDF, etc ファイルを生成するスクリプト集 </li></ul><ul><li>特徴 </li></ul><ul><ul><li>ブラウズしやすい HTML 構造と CSS を予め用意 </li></ul></ul><ul><ul><li>JavaScript による検索機能 </li></ul></ul><ul><ul><li>Pygments を用いたコード例のシンタックスハイライト </li></ul></ul>
  7. 7. Sphinx について頂いた質問 <ul><li>Javadoc のようなものか ? </li></ul><ul><ul><li>否.コードから API ドキュメントを生成するようなものではない. </li></ul></ul><ul><ul><li>ソフトウェアのマニュアル作成などに使われている模様 </li></ul></ul><ul><li>reStructuredText は Wiki 記法と比べてどう良いのか ? </li></ul><ul><ul><li>ページリンクをすっきりまとめて書ける </li></ul></ul><ul><ul><li>Python 製 Wiki の場合 indent を気にして階層構造を書かないといけないが,これを気にする必要がない </li></ul></ul>
  8. 8. ドキュメント和訳作業の流れ <ul><li>Sphinx をインストール </li></ul><ul><li>Github で biopython-tutorial-ja を folk </li></ul><ul><li>git clone </li></ul><ul><li>ドキュメントを翻訳し, chapter*.rst と index.rst を適宜作成,書き換える </li></ul><ul><li>make html でドキュメントを生成,確認 </li></ul><ul><li>git commit, git push </li></ul><ul><li>Github で pull request を送る </li></ul><ul><li>4-7 の繰り返し </li></ul>
  9. 9. 1-3, 6-8 の説明は割愛
  10. 10. 例) chapter2.rst 元の英文のコメントとして書いておく 章,説 ごとの区切りの書き方 その下に和訳を書く ソースを書くときはこのように書く あとはプロジェクトのトップディレクトリで make html と打つと _build/html 下に美しくレイアウトされた html ドキュメントが生成されます
  11. 11. Github における Biopython 情報 <ul><li>Biopython のソース </li></ul><ul><ul><li>http://github.com/biopython/biopython </li></ul></ul><ul><li>増田泰 氏の過去の Biopython 邦訳ドキュメント </li></ul><ul><ul><li>http://github.com/whosaysni/biopython-doc-ja </li></ul></ul><ul><li>拙訳ドキュメント </li></ul><ul><ul><li>http://github.com/kozo2/biopython-tutorial-ja </li></ul></ul>
  12. 12. 私見 (Biopython と Bioconductor[R]) <ul><li>R の方が適していると思われる作業がチュートリアル中に存在 </li></ul><ul><li>上記のような作業の場合 R とのインタフェース関数を用意し R を活用した方が得策 ( 例 G-language の Rcmd) </li></ul><ul><li>そのため下記においては R を適宜使用した方がよいかも… . </li></ul><ul><ul><li>matplotlib を用いてグラフ描画している箇所 </li></ul></ul><ul><ul><li>12 章 </li></ul></ul><ul><li>下記においては Python を… . </li></ul><ul><ul><li>パーサー,文字列処理 </li></ul></ul><ul><ul><li>GenomeDiagram 関係 </li></ul></ul>翻訳のモチベーションを保てるような箇所を各人で判断し,訳していきましょう
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×