BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版
Download as pptx, pdf3 likes7,636 views
叠笔蝉迟耻诲测#64で厂辫丑颈苍虫の绍介をしてきましたが、完成度の低さの自戒を込めての耻辫濒辞补诲
1 of 19
Download to read offline
Ad
Recommended
执笔中の笔测迟丑辞苍プロフェッショナルプログラミング第2版で蝉辫丑颈苍虫を使っている话
执笔中の笔测迟丑辞苍プロフェッショナルプログラミング第2版で蝉辫丑颈苍虫を使っている话Takayuki Shimizukawa
?
Sphinxを出版に使っている事例。
以下の書籍の執筆にSphinxを使った際のシステム構成などを紹介。
?エキスパートPythonプログラミング
?Pythonプロフェッショナルプログラミング
?Sphinxをはじめよう
?Pythonプロフェッショナルプログラミング第2版JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介kk_Ataka
?
2015/10/31に开催された厂辫丑颈苍虫ワークショップ蔼関西(丑迟迟辫蝉://箩补辫补苍耻苍颈虫蝉辞肠颈别迟测.诲辞辞谤办别别辫别谤.箩辫/别惫别苍迟蝉/32899)の発表资料です。How to spread reST and Sphinx
How to spread reST and SphinxTakanori Suzuki
?
How do I spread reStructuredText and Sphinx to my project team.SIerでもSphinxを使いたい！ 前編
SIerでもSphinxを使いたい！ 前編kk_Ataka
?
Sphinxを導入したいので、競合ツールと比較しました。
refs https://github.com/gosyujin/slideshare/commit/c6918bee7bc74bcd0dcfa91371214f6832086215Sphinxを使って本を書こう #pyconjp 2012
Sphinxを使って本を書こう #pyconjp 2012Takayuki Shimizukawa
?
English version is here: /shimizukawa/writing-a-book-using-sphinx-sphinxconjp-2012
私の過去2冊の翻訳?執筆した本の経験から、Sphinxを活用して執筆環境を自動化したときの手順とそのメリットなどを紹介します。
発表時の動画はこちら: http://www.youtube.com/watch?v=7VOJpFHnPWgドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会Takayuki Shimizukawa
?
システム開発や保守、運用の現場においてドキュメントは必須のものです。
しかし、ドキュメントの作成?維持には多くのパワーがかかるため、ドキュ
メントが存在しない、資料が古いままになっているなどといった現状を多く
耳にします。
本勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、
みるみるうちに図を作成できる「blockdiag」をご紹介します。
「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの
画像ファイルを出力可能なオープンソースの画像生成ツールです。書き
やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに
配置や並べ替えに苦労する必要はありません。
blockdiagのサンプルはこちら
このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成
するツール「Sphinx」を組み合わせることによって、スピーディなドキュメント
作成?維持が可能となります。
本勉強会では「blockdiag」と組み合わせて利用されることの多いドキュメン
テーションツール「Sphinx」にも触れつつ以下の構成で紹介します。
- 「blockdiag」とは何か。他のツールとの比較
- 「blockdiag」シリーズの紹介
- 「blockdiag」利用例紹介、デモ
- 「blockdiag」と連携するツール Trac, MoinMoin, Sphinx
- Sphinxとblockdiagによるドキュメント作成デモ
ドキュメント作りが楽しくなると、ソフトウェア開発や運用はきっともっとずっと
楽しくなります。
そしてこの勉強会で、「blockdiag」と「Sphinx」の先に「Webの未来」をきっと
感じることができるでしょう。ドキュメントシステムはこれを使え2015年版
ドキュメントシステムはこれを使え2015年版Keiichiro Shikano
?
Sphinx Con JP 2015での発表
目的からドキュメントシステムを選べるYes/Noチャートは33ページにあります。
（当初アップロードしたものはこのページにミスがあったので差し替えています。高橋さんありがとうございます。）Sphinxで作る貢献しやすい ドキュメント翻訳の仕組み
Sphinxで作る貢献しやすい ドキュメント翻訳の仕組みTakayuki Shimizukawa
?
Sphinxには、多言語化サポート機能があります。 この機能を使用せずにSphinxで書かれたドキュメントを翻訳するには、ドキュメントのソースを書き換えることになります。 しかし、この方法には3つの問題があります。
Sphinxの文章フォーマットを壊さないように気をつけなければならない
多数のボランティアによる翻訳の分担がしづらい、ボランティア参加しづらい
オリジナルドキュメントが更新されたとき、翻訳ドキュメントを追従させるのが難しい
そこで、Sphixnの多言語化サポート機能を利用します。 Sphinxはgettext形式の翻訳カタログの入出力に対応しているので、翻訳支援機能を備えたさまざまなツールやサービスを簡単に利用できます。 翻訳支援サービスを使うことで、Sphinxのドキュメント翻訳は以下のように実施出来ます。
パラグラフ単位で翻訳できる（Sphinxがパラグラフ単位で翻訳カタログに出力します）
多人数で同時編集できる
翻訳メモリや自動翻訳などの機能を使える
このようなサービスを利用すると、ボランティアが翻訳に参加しやすくなります。 Sphinx-users.jpチームは、Sphinxとtransifexというサービスを組み合わせて、ドキュメント翻訳の仕組みを作りました。 さらに、drone.ioを使ってプロセス全体を自動化しています。 これによって、(A)元のドキュメントが更新されたときに、transifexの翻訳元文章が更新されます。(B)transifexで翻訳が行われると、その翻訳を取り込んだドキュメントが自動ビルドされてホスティングサーバーにデプロイされます。
このセッションでは、プロセスの全体像と、自動化の仕組みについて紹介し、Sphinxで書かれたドキュメントを翻訳するうえでのヒント、コツ、そして注意点についてお話しします。More Related Content
What's hot (20)
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介kk_Ataka
?
2015/10/31に开催された厂辫丑颈苍虫ワークショップ蔼関西(丑迟迟辫蝉://箩补辫补苍耻苍颈虫蝉辞肠颈别迟测.诲辞辞谤办别别辫别谤.箩辫/别惫别苍迟蝉/32899)の発表资料です。How to spread reST and Sphinx
How to spread reST and SphinxTakanori Suzuki
?
How do I spread reStructuredText and Sphinx to my project team.SIerでもSphinxを使いたい！ 前編
SIerでもSphinxを使いたい！ 前編kk_Ataka
?
Sphinxを導入したいので、競合ツールと比較しました。
refs https://github.com/gosyujin/slideshare/commit/c6918bee7bc74bcd0dcfa91371214f6832086215Sphinxを使って本を書こう #pyconjp 2012
Sphinxを使って本を書こう #pyconjp 2012Takayuki Shimizukawa
?
English version is here: /shimizukawa/writing-a-book-using-sphinx-sphinxconjp-2012
私の過去2冊の翻訳?執筆した本の経験から、Sphinxを活用して執筆環境を自動化したときの手順とそのメリットなどを紹介します。
発表時の動画はこちら: http://www.youtube.com/watch?v=7VOJpFHnPWgドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会Takayuki Shimizukawa
?
システム開発や保守、運用の現場においてドキュメントは必須のものです。
しかし、ドキュメントの作成?維持には多くのパワーがかかるため、ドキュ
メントが存在しない、資料が古いままになっているなどといった現状を多く
耳にします。
本勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、
みるみるうちに図を作成できる「blockdiag」をご紹介します。
「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの
画像ファイルを出力可能なオープンソースの画像生成ツールです。書き
やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに
配置や並べ替えに苦労する必要はありません。
blockdiagのサンプルはこちら
このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成
するツール「Sphinx」を組み合わせることによって、スピーディなドキュメント
作成?維持が可能となります。
本勉強会では「blockdiag」と組み合わせて利用されることの多いドキュメン
テーションツール「Sphinx」にも触れつつ以下の構成で紹介します。
- 「blockdiag」とは何か。他のツールとの比較
- 「blockdiag」シリーズの紹介
- 「blockdiag」利用例紹介、デモ
- 「blockdiag」と連携するツール Trac, MoinMoin, Sphinx
- Sphinxとblockdiagによるドキュメント作成デモ
ドキュメント作りが楽しくなると、ソフトウェア開発や運用はきっともっとずっと
楽しくなります。
そしてこの勉強会で、「blockdiag」と「Sphinx」の先に「Webの未来」をきっと
感じることができるでしょう。ドキュメントシステムはこれを使え2015年版
ドキュメントシステムはこれを使え2015年版Keiichiro Shikano
?
Sphinx Con JP 2015での発表
目的からドキュメントシステムを選べるYes/Noチャートは33ページにあります。
（当初アップロードしたものはこのページにミスがあったので差し替えています。高橋さんありがとうございます。）Sphinxで作る貢献しやすい ドキュメント翻訳の仕組み
Sphinxで作る貢献しやすい ドキュメント翻訳の仕組みTakayuki Shimizukawa
?
Sphinxには、多言語化サポート機能があります。 この機能を使用せずにSphinxで書かれたドキュメントを翻訳するには、ドキュメントのソースを書き換えることになります。 しかし、この方法には3つの問題があります。
Sphinxの文章フォーマットを壊さないように気をつけなければならない
多数のボランティアによる翻訳の分担がしづらい、ボランティア参加しづらい
オリジナルドキュメントが更新されたとき、翻訳ドキュメントを追従させるのが難しい
そこで、Sphixnの多言語化サポート機能を利用します。 Sphinxはgettext形式の翻訳カタログの入出力に対応しているので、翻訳支援機能を備えたさまざまなツールやサービスを簡単に利用できます。 翻訳支援サービスを使うことで、Sphinxのドキュメント翻訳は以下のように実施出来ます。
パラグラフ単位で翻訳できる（Sphinxがパラグラフ単位で翻訳カタログに出力します）
多人数で同時編集できる
翻訳メモリや自動翻訳などの機能を使える
このようなサービスを利用すると、ボランティアが翻訳に参加しやすくなります。 Sphinx-users.jpチームは、Sphinxとtransifexというサービスを組み合わせて、ドキュメント翻訳の仕組みを作りました。 さらに、drone.ioを使ってプロセス全体を自動化しています。 これによって、(A)元のドキュメントが更新されたときに、transifexの翻訳元文章が更新されます。(B)transifexで翻訳が行われると、その翻訳を取り込んだドキュメントが自動ビルドされてホスティングサーバーにデプロイされます。
このセッションでは、プロセスの全体像と、自動化の仕組みについて紹介し、Sphinxで書かれたドキュメントを翻訳するうえでのヒント、コツ、そして注意点についてお話しします。Similar to BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版 (20)
2024_09_06_JAWS-UG山梨 【第1回】勉強会_AWS Amplify Gen2て?高速フ?ロトタイヒ?ンク?.pptx
2024_09_06_JAWS-UG山梨 【第1回】勉強会_AWS Amplify Gen2て?高速フ?ロトタイヒ?ンク?.pptxkimuraittokd3
?
JAWS-UG山梨 【第1回】勉強会 (https://jaws-ug-yamanashi.connpass.com/event/322740/)登壇時の発表資料ですcs-10. Python の基礎（オブジェクト，メソッド，引数，文字列）
cs-10. Python の基礎（オブジェクト，メソッド，引数，文字列） kunihikokaneko1
?
トピックス：Python，Python の基礎，オブジェクト，メソッド，引数，文字列，インポート ，CodeCombat情報工学, コンピューターサイエンス,
コンピューターサイエンス（全１５回）
https://www.kkaneko.jp/cc/cs/index.html
金子邦彦研究室ホームページ
https://www.kkaneko.jp/index.html
YouTube 動画
https://youtu.be/vUJKLwNQn44OSS ソースコードサーチツールの効能、有効活用方法
OSS ソースコードサーチツールの効能、有効活用方法Open Source Software Association of Japan
?
OSSAJミニセニナー開催要領
タイトル：OSSソースコードサーチツールの効能、有効活用方法の討論
講演概要：オープンソースを真に活用するとは、単に安価でソフトウェアを利用するだけではなく、ソースコードを再利用する、また改良して活用すること。OSSの理解、再利用、改変を支援する便利な検索ツールであるコードサーチツールの解説とOSSを実際に検索するデモを行います。
日時：2009年12月14日（月）16:00～19:30
15：45～16：00 受付
16：00～18：00 セミナー
18：00～19：30 Q&Aとフリーディスカッション（軽食付き）
会場：関東ITソフトウェア健保会館 市ヶ谷（曙橋）D会議室
地図：下記URLをご参照下さい
http://www.its-kenpo.or.jp/restaurant/itigaya_kaigisitu/index.html
講師：（株）SRA 葉雲文
参加費用：賛助会員、正会員 ： 500円（軽食費含む）
一般会員、協賛団体会員 ：1,000円（軽食費含む）
上記以外のゲスト参加 ：1,500円（軽食費含む）
（当日、受付時に参加費をお支払い下さい。領収書を発行致します）
お申込み?お問合せ
下記参加お申込書を参考に、mailまたはFAXにてお申し込み下さい。
Mail: adm@ossaj.org FAX: 03-5940-4582
その他：会場?食事の手配の都合上、セミナーへ参加お申込された後の取消しはできませんのでご注意下さい。なお参加できない場合は、代理の方にご出席頂きますようご手配の程お願い致します。SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまで
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまでStudy Group by SciencePark Corp.
?
勉強会で発表した資料。
https://sciencepark.connpass.com/event/140913/Firefox OSアーキテクチャクイックツアー
Firefox OSアーキテクチャクイックツアーMasami Yabushita
?
FIrefox OS Architecture quick tour.
Lecture at WANKUMA Seminar Oosaka #63.YAPC::Asia 2014 - 半端なPHPDisでPHPerに陰で笑われないためのPerl Monger向け最新PHP事情
YAPC::Asia 2014 - 半端なPHPDisでPHPerに陰で笑われないためのPerl Monger向け最新PHP事情Junichi Ishida
?
YAPC::Asia 2014にてトークした、Perl Monger向けのPHP紹介トークのスライドです。人工知能の技術て?有名なニューラルネットワークのフレームワークて?ある #Chainer を用いた対話botを使った俺の屍を越えてゆけ slide share
人工知能の技術て?有名なニューラルネットワークのフレームワークて?ある #Chainer を用いた対話botを使った俺の屍を越えてゆけ slide shareOgushi Masaya
?
2016 年はLINE, FacebookなどがAPIを公開したことでBotの活躍する場がますます増えてきています。決めうちで回答を返したり、各企業が提供しているAPIを 使って対話用のBotを作成することも可能ですが、本スライドではChainerを使用して対話Botを作成してみました。
Twitter
- https://twitter.com/SnowGushiGit
Qiita
- http://qiita.com/GushiSnow/items/79ca7deeb976f50126d7
Youtube
- https://youtu.be/2eGs_Qpt_aQ别苍肠丑补苍迟.箩蝉を使った子ども向けプログラミングワークショップ讲义内容
别苍肠丑补苍迟.箩蝉を使った子ども向けプログラミングワークショップ讲义内容Yuki Tanaka
?
三重県の子ども向けプログラミングワークショップ「Littole Code Mie」にて実施した講義内容。
テーマは「キーボードでのプログラミングに挑戦してみよう。」。
Scratch経験者かつある程度キーボード入力が可能な人を条件に、
小学校高学年の子どもたちと一緒に行いました。
Little Coder Mie
http://ws.moyashi-koubou.com/Ad
More from Go Yamada (7)
Common usage of Sphinx
Common usage of SphinxGo Yamada
?
The document discusses Go Yamada's presentation on using Sphinx to help with file management and creating websites. It describes two examples of using Sphinx to create an HTML document with links to files and to build a website to view daily reports. The presentation concludes that while Sphinx is not all-purpose, it can be effective for easy documentation and its benefits outweigh the costs of using it.Ad
BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版
- 1. BPstudy#64 Sphinx-users.jp 山田剛
- 2. お前誰よ：山田 剛 Twitter: @usaturn ? 仕事 ? (株) ネットサポート所属 ? アウトソーシング業を営むIT企業 ? 参加コミュニティ(勉強会) ? Python系 ? Mercurial系 ? Vim系 ? アジャイル系 ? その他 ? インフラ系エンジニア ? sh、awk、vbs等は使えますが汎用言語の経験無し ? “改善”、”効率化”が好き。というか楽したい
- 3. アジェンダ 1. Sphinxってどんな物？ 2. Sphinxを使ってみよう！ 3. 既存のドキュメンテーションツールとの 比較 4. 利用例
- 4. 1. Sphinxってどんな物？ 2. Sphinxを使ってみよう！ 3. 既存のドキュメンテーションツールとの 比較 4. 利用例
- 6. 豊富な出力フォーマット ? html ? latex ? pdf ? json ? htmlhelp ? epub ? text ? man .......etc
- 8. 1. Sphinxってどんな物？ 2. Sphinxを使ってみよう！ 3. 既存のドキュメンテーションツールとの 比較 4. 利用例
- 10. 1. Sphinxってどんな物？ 2. Sphinxを使ってみよう！ 3. 既存のドキュメンテーションツールとの 比較 4. 利用例
- 13. Wordの特徴 ドキュメント作成専用ツールWord ?誰でも使える（事になっている） ?手軽にお絵かき ?単体でバージョン管理、マージ等も可能。 ?アウトライン ?余計なお世話機能 非常に高機能な反面複 雑で習得し辛い
- 14. Wikiの特徴 Wikiクローン （pukiwiki、Mediawiki、TracWiki…etc） ?比較的簡単な記法 ?Webサーバが必要 ?バージョン管理やアカウント制御等、機 能豊富 ?自由度が高いので、ルールを決めて使う 必要がある。
- 15. Sphinxの特徴 ?プレーンテキストである為に、バージョ ン管理しやすい -> 複数人で編集しやす い！ ?toctreeにより階層構造を促され、文書作 成が横道にそれにくい ?文書の分割、結合が楽 ?さまざまな拡張があり、拡張を自身で作 成する事も可能
- 16. 1. Sphinxってどんな物？ 2. Sphinxを使ってみよう！ 3. 既存のドキュメンテーションツールとの 比較 4. 利用例
- 17. 1. Sphinxってどんな物？ 2. Sphinxを使ってみよう！ 3. 既存のドキュメンテーションツールとの 比較 4. 利用例
- 18. 利用例 ? 利用例さまざまなオープンソースのプロ ジェクトで利用されています。 http://sphinx-users.jp/example.html