2017年8月28日

「ドキュメントを書きたくなってしまう魔法のツール Sphinx 入門」参加者募集中です。


PyCon JP 2017 チュートリアル担当の高倉です。

今回は、「ドキュメントを書きたくなってしまう魔法のツール Sphinx 入門」のチュートリアルの紹介をいたします。

Sphinxとは、reStructuredText(reST)記法と呼ばれる、Markdownによく似た記法を使ってHTML, ePub, PDFなどの複数のドキュメント形式に併せたドキュメントを作成できるツールです。
HTMLを作成する場合は様々なテーマを選んで作ることが可能です。
reStructuredText記法はプレーンテキストベースなので、好きなエディタを使って編集ができ、Gitなどのバージョン管理ツールを使ってのバージョン管理ができます。
バージョン管理ツールでの管理がしやすいということは、何か間違えてもすぐにもとの版に戻すことができたり、複数人での執筆がよりやりやすくなったりと利点が多くあります。
なお、SphinxではMarkdownは拡張機能を入れることでそのまま扱うことができます。
その他の拡張機能も多く、たとえばコードを書くことでフローチャートのような図を書くことができたり、ソースコードにコメントを書くことでドキュメントを生成できたりします。
最近ではSphinxはLinuxのカーネルのドキュメントや、Debianのドキュメントなどでも使われるようになり、注目を集めています。

今回のチュートリアルでは、HTMLへの変換や、基本的な段落、箇条書き、文字の強調、リンク、コードブロック、表、画像、そしてファイルのリンクを使ったreStructuredText記法の書き方、そしてMarkdownとの併用やSphinxリファレンスの読み方、わからなくなったときの助けの呼び方などを扱う予定です。
なお、当日の講師およびTAとして、Sphinxの開発に実際に携わっているSphinx-Users.jpの皆様が参加予定です。
もしかしたら、普段聞けないお話が聞けるかもしれません。

当日は、SphinxをインストールしたPCをお持ちください。
http://sphinx-users.jp/gettingstarted/index.html に手順が掲載されています。
わからないことがあった場合、connpass のコメント欄や Twitter( #sphinxjp タグ付き)などで質問していただけるとサポート可能です。

平日の日中の開催になってしまいますが、お誘い合わせの上、お申し込みいただければ幸いです。

参加申し込みは8/31(木)23:59までとなっておりますので、お早めにお申し込みください。

お申し込みはこちらから(connpass)

0 件のコメント:

コメントを投稿