SlideShare a Scribd company logo
1 of 35
Download to read offline
Sphinx-users.jp
        小宮健
お前だれよ
                            Twitter: @tk0miya
 仕事
   (株)タイムインターメディア所属
   テクニカルオフィサ(技術責任者)として活動
 参加コミュニティ
   Sphinx-users.jp
   Python mini hack-a-thon
 Sphinx を中心にツールを開発
    blockdiag シリーズ
    Sphinx 拡張機能の開発
      Googlechart やカレンダー機能
 #bookathon 他読書会やってます
祝!SphinxConJP 2012 開催!




 世界ではじめてのSphinxカンファレンスへよ
 うこそ
   7件の発表
   明日の Sprint Day でもなにかやります
 Enjoy Sphinx :-)
アンケート

 Sphinx 使っていますか?
 1. 初めて聞いた
 2. 名前は聞いたことはある
 3. インストールはしてみた
 4. もう使ってるよ
Sphinx-users.jp
        小宮健
アジェンダ

1. Sphinx について
2. Sphinx の現在
3. Sphinx の未来
4. Sphinx コミュニティの紹介
5. まとめ
Sphinx とは?

 Georg Brandl 謹製のドキュメントツール
 オープンソース (BSD ライセンス)
Sphinx の特徴

 テキストから各種フォーマットへの変換
   HTML, PDF など多くのフォーマットに対
    応
Sphinx の特徴
Sphinx の特徴

 シンプルなマークアップ
   reST (reSTructured Text)
   Wiki 記法みたいなもの
  ======
  見出し
  ======

  * 箇条書き
  * 箇条書き

 目次(toctree)ベースで文書構造を作る
Sphinx のよいところ

 ソースがテキスト形式
   環境/エディタを選ばない
   バージョン管理できる
   ツールで自動生成しやすい
     例) schema2rst (DB定義抽出)
 機能を拡張することが出来る
   Sphinx 拡張やテーマで表現力アップ
 目次(toctree)ベースなので文章が書きやすい
Sphinx のいまいちなところ

 変換する必要がある
   reST を書いて make する、の繰り返し
   ツールを使って自動化できるが…
 reST は文書レイアウトを表現できない
    右寄せ、センタリング、二段組などの表現が
     ない
    割り切りが必要
 画像や図などは別途作る必要がある
    Office スイートになれていると、ちょっと不
     便 :-(
Sphinx の主な用途

 開発ドキュメント
  Python 等 OSS のドキュメント
  設計書、マニュアルなど
 Web サイト
   ブログ風、コーポレートサイト
 出版
  エキスパート Python プログラミング
  Python プロフェッショナルプログラミング
  その他多数
他のツールとの比較

 Word
   ◯ 縦書き表記ができる
   ◯ 日本語の文法チェック機能がある
   ◯ 変更履歴の管理がしやすい
   ◯ 画像や図の差し込みが簡単
   ✕ 文書構成をいじるのが大変
   ✕ 複数人で管理するのもやりづらい
   ✕ Office スイートが必要
他のツールとの比較

 Excel
    ◯ 誰でも使える。事実上の標準ツール
    ◯ 方眼紙ライクな図、説明が書きやすい
    ✕ 文章構成が存在しない
    ✕ 編集、とくにセルの調整を始めると…
    ✕ 印刷しづらいドキュメントができる
    ✕ Office スイートが必要
他のツールとの比較

 Wiki
   ◯ ブラウザだけで編集できる
   ◯ 記法がわかりやすく書きやすい
   ✕ 図や画像は別途作成する必要がある
   ✕ 構成がネットワーク状で迷子になりやす
    い
   ✕ 文書レイアウトは指定しづらい(できな
    い)
他のツールとの比較

 Sphinx-users.jp コンテンツの拡充
 readthedocs の登場
 日本語 PDF 環境の整備
 Sphinx 拡張の増加
 Sphinx テーマの増加
 利用事例の増加
Sphinx-users.jp コンテンツの拡充

 http://sphinx-users.jp/
 初心者向けコンテンツ
 Tips 集
   PDF 出力やテーマ
   各種拡張の紹介
 逆引き辞典
 イベント情報
readthedocs の登場

 Sphinx ドキュメントのホスティングサー
  ビス
 ドキュメントをビルド、公開してくれる
 GitHub や BitBucket などにコミットする
  だけ
 文章を書いて公開するのが簡単に
日本語 PDF 環境の整備

 日本語 PDF は環境設定が大変だった
 打田さんの手によって環境が整ってきた
  1. Sphinx にパッチを当てる
  2. TeXLive (2011以降)を入れる
  3. conf.py をいじる
  4. make latexpdfja を実行する
 パッチは本家への取り込みを申請中
 詳細な手順は sphinx-users.jp で!
Sphinx 拡張の増加

 様々なメディアに対応する拡張
   Youtube, Slideshare, Google Maps
 図形を簡単に書くための拡張
   blockdiag, seqdiag, plantuml
 reST を書きやすくする拡張
    wikitable, japanesesupport
 その他
   テーマ追加、装飾追加(取り消し線、赤字な
    ど)
Sphinx テーマの増加

 theme.core 拡張によりテーマの追加が可能
  に
 スライド系のテーマ
   S6 (sphinxjp.themes.s6)
   htmlslide (sphinxjp.themes.htmlslide)
   impressjs (sphinxjp.themes.impressjs)
 格好いいテーマ
   bizstyle (sphinxjp.themes.bizstyle)
   Solarized (sphinxjp.themes.solarized)
利用事例の増加

 OSS での利用は順調に増加
   Python 本体、様々なライブラリ
   Python 以外でも利用され始めている
   Symphony2, CakePHP
 伝聞では、業務での利用が増えている
   社内では HTML で共有
   PDF に変換して納品
 コーポレートサイトに利用されている例
も!
Sphinx の未来

 日本語 PDF のパッチ取り込み
  標準で PDF が生成できるように
  本家にはたらきかけていく
 変換の自動化
   Jenkins での変換/公開を簡単にしたい
 PDF テーマ
    PDF 出力した時の見栄えを変更したい
    TeX の知識がなくても変更できるように
Sphinx の未来

 テーマや拡張をさらに増やす
   まだ表現できないものも多い
   画像など手間のかかるものもある
   選択肢と自由度を上げていきたい
 Sphinx Web エディタ
  ブラウザだけで文章を編集したい
  より Wiki の手軽さに近づけていく
 利用事例
   仕事で使えると幸せになれるはず!
Sphinx の未来

 今日の SphinxCon は未来への第一歩
 扱っているテーマ
   Sphinx 拡張 探訪 (拡張)
   Sphinx HTML theme 事始め (テーマ)
   Sphinx を使って本を書こう (自動化)
   Sphinx の平凡な使い方 (利用事例)
   社内での Sphinx、reST の広め方 (利用事例)
   Sphinx におけるdocutils の役割(Webエディタ
    他)
Sphinx-users.jp

 Sphinx コミュニティの運営
    メーリングリスト
    Twitter (#sphinxjp)
 サイトの運営、マニュアルの翻訳
 イベント開催
   Sphinx+翻訳 Hack-a-thon (東京)
   Sphinx 朝会 (大阪)
   Sphinx ハンズオン
   SphinxCon JP 2012
Sphinx で困ったら…

 Sphinx-users.jp に相談してください
 Twitter、ML、イベントなんでも構いませ
 ん
  質問してみる
  回答してみる
  共有する
イベント開催予定

 SphinxCon Sprint
    9/17(月) PyCon Sprint 会場で開催
    ハンズオンもしくは Sprint をやります


 Sphinx+翻訳 Hack-a-thon
    10/13(土) タイムインターメディア社で開催
    Connpass に募集ページあり
    Hack-a-thon スタイル、雑談の場
まとめ

 Sphinx について
 Sphinx の現在
 Sphinx の未来
 Sphinx コミュニティの紹介
 Sphinx+翻訳 Hack-a-thon 10月もやるよ


 Enjoy Documentation!

More Related Content

What's hot

CMSI計算科学技術特論B(14) OpenACC・CUDAによるGPUコンピューティング
CMSI計算科学技術特論B(14) OpenACC・CUDAによるGPUコンピューティングCMSI計算科学技術特論B(14) OpenACC・CUDAによるGPUコンピューティング
CMSI計算科学技術特論B(14) OpenACC・CUDAによるGPUコンピューティングComputational Materials Science Initiative
 
kubernetes初心者がKnative Lambda Runtime触ってみた(Kubernetes Novice Tokyo #13 発表資料)
kubernetes初心者がKnative Lambda Runtime触ってみた(Kubernetes Novice Tokyo #13 発表資料)kubernetes初心者がKnative Lambda Runtime触ってみた(Kubernetes Novice Tokyo #13 発表資料)
kubernetes初心者がKnative Lambda Runtime触ってみた(Kubernetes Novice Tokyo #13 発表資料)NTT DATA Technology & Innovation
 
Optimizations in Spark; RDD, DataFrame
Optimizations in Spark; RDD, DataFrameOptimizations in Spark; RDD, DataFrame
Optimizations in Spark; RDD, DataFrameKnoldus Inc.
 
ディープラーニングおじさんの話
ディープラーニングおじさんの話ディープラーニングおじさんの話
ディープラーニングおじさんの話karaage0703
 
Kubernetes Cost Optimization
Kubernetes Cost OptimizationKubernetes Cost Optimization
Kubernetes Cost OptimizationShiho ASA
 
シリコンバレーでエンジニア就職する前に知りたかったこと
シリコンバレーでエンジニア就職する前に知りたかったことシリコンバレーでエンジニア就職する前に知りたかったこと
シリコンバレーでエンジニア就職する前に知りたかったことTatsuya Nanjo
 
大規模データ処理の定番OSS Hadoop / Spark 最新動向 - 2021秋 -(db tech showcase 2021 / ONLINE 発...
大規模データ処理の定番OSS Hadoop / Spark 最新動向 - 2021秋 -(db tech showcase 2021 / ONLINE 発...大規模データ処理の定番OSS Hadoop / Spark 最新動向 - 2021秋 -(db tech showcase 2021 / ONLINE 発...
大規模データ処理の定番OSS Hadoop / Spark 最新動向 - 2021秋 -(db tech showcase 2021 / ONLINE 発...NTT DATA Technology & Innovation
 
RDB技術者のためのNoSQLガイド NoSQLの必要性と位置づけ
RDB技術者のためのNoSQLガイド NoSQLの必要性と位置づけRDB技術者のためのNoSQLガイド NoSQLの必要性と位置づけ
RDB技術者のためのNoSQLガイド NoSQLの必要性と位置づけRecruit Technologies
 
How to Schedule Machine Learning Workloads Nicely In Kubernetes #CNDT2020 / C...
How to Schedule Machine Learning Workloads Nicely In Kubernetes #CNDT2020 / C...How to Schedule Machine Learning Workloads Nicely In Kubernetes #CNDT2020 / C...
How to Schedule Machine Learning Workloads Nicely In Kubernetes #CNDT2020 / C...Preferred Networks
 
乱数と擬似乱数の生成技術
乱数と擬似乱数の生成技術乱数と擬似乱数の生成技術
乱数と擬似乱数の生成技術SeiyaSakata
 
[Cloud OnAir] GCP 上でストリーミングデータ処理基盤を構築してみよう! 2018年9月13日 放送
[Cloud OnAir] GCP 上でストリーミングデータ処理基盤を構築してみよう! 2018年9月13日 放送[Cloud OnAir] GCP 上でストリーミングデータ処理基盤を構築してみよう! 2018年9月13日 放送
[Cloud OnAir] GCP 上でストリーミングデータ処理基盤を構築してみよう! 2018年9月13日 放送Google Cloud Platform - Japan
 
Fast and Light-weight Binarized Neural Network Implemented in an FPGA using L...
Fast and Light-weight Binarized Neural Network Implemented in an FPGA using L...Fast and Light-weight Binarized Neural Network Implemented in an FPGA using L...
Fast and Light-weight Binarized Neural Network Implemented in an FPGA using L...ryuz88
 
CPU / GPU高速化セミナー!性能モデルの理論と実践:実践編
CPU / GPU高速化セミナー!性能モデルの理論と実践:実践編CPU / GPU高速化セミナー!性能モデルの理論と実践:実践編
CPU / GPU高速化セミナー!性能モデルの理論と実践:実践編Fixstars Corporation
 
Node-REDのプログラミングモデル
Node-REDのプログラミングモデルNode-REDのプログラミングモデル
Node-REDのプログラミングモデルAtsushi Kojo
 
PyConAPAC2023 ワークフローエンジン Apache Airflowを用いた 大規模データパイプライン構築と改善
PyConAPAC2023 ワークフローエンジン  Apache Airflowを用いた 大規模データパイプライン構築と改善PyConAPAC2023 ワークフローエンジン  Apache Airflowを用いた 大規模データパイプライン構築と改善
PyConAPAC2023 ワークフローエンジン Apache Airflowを用いた 大規模データパイプライン構築と改善株式会社MonotaRO Tech Team
 
Containers + EC2 Spot: AWS Batch による大規模バッチ処理でのスポットインスタンス活用
Containers + EC2 Spot: AWS Batch による大規模バッチ処理でのスポットインスタンス活用Containers + EC2 Spot: AWS Batch による大規模バッチ処理でのスポットインスタンス活用
Containers + EC2 Spot: AWS Batch による大規模バッチ処理でのスポットインスタンス活用Daisuke Miyamoto
 
Chainer で Tensor コア (fp16) を使いこなす
Chainer で Tensor コア (fp16) を使いこなすChainer で Tensor コア (fp16) を使いこなす
Chainer で Tensor コア (fp16) を使いこなすNVIDIA Japan
 
クラウドネイティブ時代の オブザーバビリティとは? 〜 SignalFxで実現するマイクロサービスの トレーサビリティとリアルタイム監視・分析 〜
クラウドネイティブ時代の オブザーバビリティとは? 〜 SignalFxで実現するマイクロサービスの トレーサビリティとリアルタイム監視・分析 〜クラウドネイティブ時代の オブザーバビリティとは? 〜 SignalFxで実現するマイクロサービスの トレーサビリティとリアルタイム監視・分析 〜
クラウドネイティブ時代の オブザーバビリティとは? 〜 SignalFxで実現するマイクロサービスの トレーサビリティとリアルタイム監視・分析 〜Kunihiko Ikeyama
 

What's hot (20)

CMSI計算科学技術特論B(14) OpenACC・CUDAによるGPUコンピューティング
CMSI計算科学技術特論B(14) OpenACC・CUDAによるGPUコンピューティングCMSI計算科学技術特論B(14) OpenACC・CUDAによるGPUコンピューティング
CMSI計算科学技術特論B(14) OpenACC・CUDAによるGPUコンピューティング
 
kubernetes初心者がKnative Lambda Runtime触ってみた(Kubernetes Novice Tokyo #13 発表資料)
kubernetes初心者がKnative Lambda Runtime触ってみた(Kubernetes Novice Tokyo #13 発表資料)kubernetes初心者がKnative Lambda Runtime触ってみた(Kubernetes Novice Tokyo #13 発表資料)
kubernetes初心者がKnative Lambda Runtime触ってみた(Kubernetes Novice Tokyo #13 発表資料)
 
Optimizations in Spark; RDD, DataFrame
Optimizations in Spark; RDD, DataFrameOptimizations in Spark; RDD, DataFrame
Optimizations in Spark; RDD, DataFrame
 
ディープラーニングおじさんの話
ディープラーニングおじさんの話ディープラーニングおじさんの話
ディープラーニングおじさんの話
 
C# 9.0 / .NET 5.0
C# 9.0 / .NET 5.0C# 9.0 / .NET 5.0
C# 9.0 / .NET 5.0
 
Kubernetes Cost Optimization
Kubernetes Cost OptimizationKubernetes Cost Optimization
Kubernetes Cost Optimization
 
シリコンバレーでエンジニア就職する前に知りたかったこと
シリコンバレーでエンジニア就職する前に知りたかったことシリコンバレーでエンジニア就職する前に知りたかったこと
シリコンバレーでエンジニア就職する前に知りたかったこと
 
大規模データ処理の定番OSS Hadoop / Spark 最新動向 - 2021秋 -(db tech showcase 2021 / ONLINE 発...
大規模データ処理の定番OSS Hadoop / Spark 最新動向 - 2021秋 -(db tech showcase 2021 / ONLINE 発...大規模データ処理の定番OSS Hadoop / Spark 最新動向 - 2021秋 -(db tech showcase 2021 / ONLINE 発...
大規模データ処理の定番OSS Hadoop / Spark 最新動向 - 2021秋 -(db tech showcase 2021 / ONLINE 発...
 
RDB技術者のためのNoSQLガイド NoSQLの必要性と位置づけ
RDB技術者のためのNoSQLガイド NoSQLの必要性と位置づけRDB技術者のためのNoSQLガイド NoSQLの必要性と位置づけ
RDB技術者のためのNoSQLガイド NoSQLの必要性と位置づけ
 
How to Schedule Machine Learning Workloads Nicely In Kubernetes #CNDT2020 / C...
How to Schedule Machine Learning Workloads Nicely In Kubernetes #CNDT2020 / C...How to Schedule Machine Learning Workloads Nicely In Kubernetes #CNDT2020 / C...
How to Schedule Machine Learning Workloads Nicely In Kubernetes #CNDT2020 / C...
 
乱数と擬似乱数の生成技術
乱数と擬似乱数の生成技術乱数と擬似乱数の生成技術
乱数と擬似乱数の生成技術
 
[Cloud OnAir] GCP 上でストリーミングデータ処理基盤を構築してみよう! 2018年9月13日 放送
[Cloud OnAir] GCP 上でストリーミングデータ処理基盤を構築してみよう! 2018年9月13日 放送[Cloud OnAir] GCP 上でストリーミングデータ処理基盤を構築してみよう! 2018年9月13日 放送
[Cloud OnAir] GCP 上でストリーミングデータ処理基盤を構築してみよう! 2018年9月13日 放送
 
Fast and Light-weight Binarized Neural Network Implemented in an FPGA using L...
Fast and Light-weight Binarized Neural Network Implemented in an FPGA using L...Fast and Light-weight Binarized Neural Network Implemented in an FPGA using L...
Fast and Light-weight Binarized Neural Network Implemented in an FPGA using L...
 
CPU / GPU高速化セミナー!性能モデルの理論と実践:実践編
CPU / GPU高速化セミナー!性能モデルの理論と実践:実践編CPU / GPU高速化セミナー!性能モデルの理論と実践:実践編
CPU / GPU高速化セミナー!性能モデルの理論と実践:実践編
 
Node-REDのプログラミングモデル
Node-REDのプログラミングモデルNode-REDのプログラミングモデル
Node-REDのプログラミングモデル
 
PyConAPAC2023 ワークフローエンジン Apache Airflowを用いた 大規模データパイプライン構築と改善
PyConAPAC2023 ワークフローエンジン  Apache Airflowを用いた 大規模データパイプライン構築と改善PyConAPAC2023 ワークフローエンジン  Apache Airflowを用いた 大規模データパイプライン構築と改善
PyConAPAC2023 ワークフローエンジン Apache Airflowを用いた 大規模データパイプライン構築と改善
 
Containers + EC2 Spot: AWS Batch による大規模バッチ処理でのスポットインスタンス活用
Containers + EC2 Spot: AWS Batch による大規模バッチ処理でのスポットインスタンス活用Containers + EC2 Spot: AWS Batch による大規模バッチ処理でのスポットインスタンス活用
Containers + EC2 Spot: AWS Batch による大規模バッチ処理でのスポットインスタンス活用
 
Chainer で Tensor コア (fp16) を使いこなす
Chainer で Tensor コア (fp16) を使いこなすChainer で Tensor コア (fp16) を使いこなす
Chainer で Tensor コア (fp16) を使いこなす
 
XAML Islands
XAML IslandsXAML Islands
XAML Islands
 
クラウドネイティブ時代の オブザーバビリティとは? 〜 SignalFxで実現するマイクロサービスの トレーサビリティとリアルタイム監視・分析 〜
クラウドネイティブ時代の オブザーバビリティとは? 〜 SignalFxで実現するマイクロサービスの トレーサビリティとリアルタイム監視・分析 〜クラウドネイティブ時代の オブザーバビリティとは? 〜 SignalFxで実現するマイクロサービスの トレーサビリティとリアルタイム監視・分析 〜
クラウドネイティブ時代の オブザーバビリティとは? 〜 SignalFxで実現するマイクロサービスの トレーサビリティとリアルタイム監視・分析 〜
 

Viewers also liked

Sphinxを使って本を書こう #pyconjp 2012
Sphinxを使って本を書こう #pyconjp 2012Sphinxを使って本を書こう #pyconjp 2012
Sphinxを使って本を書こう #pyconjp 2012Takayuki Shimizukawa
 
How to spread reST and Sphinx
How to spread reST and SphinxHow to spread reST and Sphinx
How to spread reST and SphinxTakanori Suzuki
 
Oktavia全文検索エンジン - SphinxCon JP 2014
Oktavia全文検索エンジン - SphinxCon JP 2014Oktavia全文検索エンジン - SphinxCon JP 2014
Oktavia全文検索エンジン - SphinxCon JP 2014Yoshiki Shibukawa
 
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会Takayuki Shimizukawa
 
APIドキュメントの話 #sphinxjp
APIドキュメントの話 #sphinxjpAPIドキュメントの話 #sphinxjp
APIドキュメントの話 #sphinxjpTakeshi Komiya
 
Sphinx拡張 探訪 2014 #sphinxjp
Sphinx拡張 探訪 2014 #sphinxjpSphinx拡張 探訪 2014 #sphinxjp
Sphinx拡張 探訪 2014 #sphinxjpTakeshi Komiya
 
Sphinxで作る貢献しやすい ドキュメント翻訳の仕組み
Sphinxで作る貢献しやすいドキュメント翻訳の仕組みSphinxで作る貢献しやすいドキュメント翻訳の仕組み
Sphinxで作る貢献しやすい ドキュメント翻訳の仕組みTakayuki Shimizukawa
 
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
Sphinx ではじめるドキュメント生活 2013 #sphinxconjpSphinx ではじめるドキュメント生活 2013 #sphinxconjp
Sphinx ではじめるドキュメント生活 2013 #sphinxconjpTakeshi Komiya
 
Sphinx で手軽に作るドキュメント
Sphinx で手軽に作るドキュメントSphinx で手軽に作るドキュメント
Sphinx で手軽に作るドキュメントGo Yamada
 
Sphinx HTML Theme Hacks
Sphinx HTML Theme HacksSphinx HTML Theme Hacks
Sphinx HTML Theme HacksShoji KUMAGAI
 
JUS関西 Sphinxワークショップ@関西 Sphinx紹介
JUS関西 Sphinxワークショップ@関西 Sphinx紹介JUS関西 Sphinxワークショップ@関西 Sphinx紹介
JUS関西 Sphinxワークショップ@関西 Sphinx紹介Takayuki Shimizukawa
 
BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版
BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版
BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版Go Yamada
 
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介kk_Ataka
 
Sphinxで社内勉強会(Git)の
資料を作ってみた
Sphinxで社内勉強会(Git)の
資料を作ってみたSphinxで社内勉強会(Git)の
資料を作ってみた
Sphinxで社内勉強会(Git)の
資料を作ってみたTaku SHIMIZU
 
Sphinxの使い方事例
Sphinxの使い方事例Sphinxの使い方事例
Sphinxの使い方事例Go Yamada
 
SIerでもSphinxを使いたい!総括
SIerでもSphinxを使いたい!総括SIerでもSphinxを使いたい!総括
SIerでもSphinxを使いたい!総括kk_Ataka
 
ドキュメントシステムはこれを使え2015年版
ドキュメントシステムはこれを使え2015年版ドキュメントシステムはこれを使え2015年版
ドキュメントシステムはこれを使え2015年版Keiichiro Shikano
 
ドキュメントを作りたくなってしまう魔法のツールSphinx
ドキュメントを作りたくなってしまう魔法のツールSphinxドキュメントを作りたくなってしまう魔法のツールSphinx
ドキュメントを作りたくなってしまう魔法のツールSphinxTakayuki Shimizukawa
 

Viewers also liked (19)

Sphinxを使って本を書こう #pyconjp 2012
Sphinxを使って本を書こう #pyconjp 2012Sphinxを使って本を書こう #pyconjp 2012
Sphinxを使って本を書こう #pyconjp 2012
 
How to spread reST and Sphinx
How to spread reST and SphinxHow to spread reST and Sphinx
How to spread reST and Sphinx
 
Oktavia全文検索エンジン - SphinxCon JP 2014
Oktavia全文検索エンジン - SphinxCon JP 2014Oktavia全文検索エンジン - SphinxCon JP 2014
Oktavia全文検索エンジン - SphinxCon JP 2014
 
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
 
APIドキュメントの話 #sphinxjp
APIドキュメントの話 #sphinxjpAPIドキュメントの話 #sphinxjp
APIドキュメントの話 #sphinxjp
 
Sphinx拡張 探訪 2014 #sphinxjp
Sphinx拡張 探訪 2014 #sphinxjpSphinx拡張 探訪 2014 #sphinxjp
Sphinx拡張 探訪 2014 #sphinxjp
 
Sphinxで作る貢献しやすい ドキュメント翻訳の仕組み
Sphinxで作る貢献しやすいドキュメント翻訳の仕組みSphinxで作る貢献しやすいドキュメント翻訳の仕組み
Sphinxで作る貢献しやすい ドキュメント翻訳の仕組み
 
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
Sphinx ではじめるドキュメント生活 2013 #sphinxconjpSphinx ではじめるドキュメント生活 2013 #sphinxconjp
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
 
Sphinx で手軽に作るドキュメント
Sphinx で手軽に作るドキュメントSphinx で手軽に作るドキュメント
Sphinx で手軽に作るドキュメント
 
Sphinx HTML Theme Hacks
Sphinx HTML Theme HacksSphinx HTML Theme Hacks
Sphinx HTML Theme Hacks
 
JUS関西 Sphinxワークショップ@関西 Sphinx紹介
JUS関西 Sphinxワークショップ@関西 Sphinx紹介JUS関西 Sphinxワークショップ@関西 Sphinx紹介
JUS関西 Sphinxワークショップ@関西 Sphinx紹介
 
BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版
BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版
BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版
 
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
 
Sphinxで社内勉強会(Git)の
資料を作ってみた
Sphinxで社内勉強会(Git)の
資料を作ってみたSphinxで社内勉強会(Git)の
資料を作ってみた
Sphinxで社内勉強会(Git)の
資料を作ってみた
 
Sphinxの使い方事例
Sphinxの使い方事例Sphinxの使い方事例
Sphinxの使い方事例
 
SIerでもSphinxを使いたい!総括
SIerでもSphinxを使いたい!総括SIerでもSphinxを使いたい!総括
SIerでもSphinxを使いたい!総括
 
Markdownもはじめよう
MarkdownもはじめようMarkdownもはじめよう
Markdownもはじめよう
 
ドキュメントシステムはこれを使え2015年版
ドキュメントシステムはこれを使え2015年版ドキュメントシステムはこれを使え2015年版
ドキュメントシステムはこれを使え2015年版
 
ドキュメントを作りたくなってしまう魔法のツールSphinx
ドキュメントを作りたくなってしまう魔法のツールSphinxドキュメントを作りたくなってしまう魔法のツールSphinx
ドキュメントを作りたくなってしまう魔法のツールSphinx
 

Similar to Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp

世界のSphinx事情 @ SphinxCon JP 2015
世界のSphinx事情 @ SphinxCon JP 2015世界のSphinx事情 @ SphinxCon JP 2015
世界のSphinx事情 @ SphinxCon JP 2015Takayuki Shimizukawa
 
社内のマニュアルをSphinxで作ってみた
社内のマニュアルをSphinxで作ってみた社内のマニュアルをSphinxで作ってみた
社内のマニュアルをSphinxで作ってみたIosif Takakura
 
ドキュメントの継続的改善―Sphinxを使いながら
ドキュメントの継続的改善―Sphinxを使いながらドキュメントの継続的改善―Sphinxを使いながら
ドキュメントの継続的改善―Sphinxを使いながらsoishino
 
ユーザ・デザイナーから見たPlone CMSのアピールポイント
ユーザ・デザイナーから見たPlone CMSのアピールポイントユーザ・デザイナーから見たPlone CMSのアピールポイント
ユーザ・デザイナーから見たPlone CMSのアピールポイントMasaki NIWA
 
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまで
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまでSphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまで
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまでStudy Group by SciencePark Corp.
 
個人的ドキュメンテーションツール トップ100
個人的ドキュメンテーションツール トップ100個人的ドキュメンテーションツール トップ100
個人的ドキュメンテーションツール トップ100Go Yamada
 
マークアップ言語の拡張 メリットとデメリット #hankumi
マークアップ言語の拡張 メリットとデメリット #hankumiマークアップ言語の拡張 メリットとデメリット #hankumi
マークアップ言語の拡張 メリットとデメリット #hankumiTakeshi Komiya
 
ドキュメントを加速する作画ツール Blockdiag 2011/07 #infotalk
ドキュメントを加速する作画ツール Blockdiag 2011/07 #infotalkドキュメントを加速する作画ツール Blockdiag 2011/07 #infotalk
ドキュメントを加速する作画ツール Blockdiag 2011/07 #infotalkTakeshi Komiya
 
SIerでもSphinxを使いたい! 前編
SIerでもSphinxを使いたい! 前編SIerでもSphinxを使いたい! 前編
SIerでもSphinxを使いたい! 前編kk_Ataka
 
Sphinxの環境構築が再現できない問題をDockerで解決してみた
Sphinxの環境構築が再現できない問題をDockerで解決してみたSphinxの環境構築が再現できない問題をDockerで解決してみた
Sphinxの環境構築が再現できない問題をDockerで解決してみたStudy Group by SciencePark Corp.
 
自社製品のバージョン管理 進化と問題解決の道のり
自社製品のバージョン管理 進化と問題解決の道のり自社製品のバージョン管理 進化と問題解決の道のり
自社製品のバージョン管理 進化と問題解決の道のりStudy Group by SciencePark Corp.
 
xUnitハンズオン第3回テキスト
xUnitハンズオン第3回テキストxUnitハンズオン第3回テキスト
xUnitハンズオン第3回テキストmizuky fujitani
 
Pyconjp2016 pyftplib
Pyconjp2016 pyftplibPyconjp2016 pyftplib
Pyconjp2016 pyftplibShinya Okano
 
DevOpsが引き金となるインフラエンジニアの進撃
DevOpsが引き金となるインフラエンジニアの進撃DevOpsが引き金となるインフラエンジニアの進撃
DevOpsが引き金となるインフラエンジニアの進撃Teruo Adachi
 
Python界隈の翻訳プロジェクト
Python界隈の翻訳プロジェクトPython界隈の翻訳プロジェクト
Python界隈の翻訳プロジェクトTetsuya Morimoto
 
Excel 方眼紙撲滅委員会 活動報告 2012.08 #pyfes
Excel 方眼紙撲滅委員会 活動報告 2012.08 #pyfesExcel 方眼紙撲滅委員会 活動報告 2012.08 #pyfes
Excel 方眼紙撲滅委員会 活動報告 2012.08 #pyfesTakeshi Komiya
 
手軽にメンテナンスできるドキュメントのヒミツ - blockdiag #odstudy 2011/07
手軽にメンテナンスできるドキュメントのヒミツ - blockdiag #odstudy 2011/07手軽にメンテナンスできるドキュメントのヒミツ - blockdiag #odstudy 2011/07
手軽にメンテナンスできるドキュメントのヒミツ - blockdiag #odstudy 2011/07Takeshi Komiya
 
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」Yoshiki Shibukawa
 
xUnitハンズオン第2回テキスト
xUnitハンズオン第2回テキストxUnitハンズオン第2回テキスト
xUnitハンズオン第2回テキストmizuky fujitani
 

Similar to Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp (20)

世界のSphinx事情 @ SphinxCon JP 2015
世界のSphinx事情 @ SphinxCon JP 2015世界のSphinx事情 @ SphinxCon JP 2015
世界のSphinx事情 @ SphinxCon JP 2015
 
社内のマニュアルをSphinxで作ってみた
社内のマニュアルをSphinxで作ってみた社内のマニュアルをSphinxで作ってみた
社内のマニュアルをSphinxで作ってみた
 
ひとりsphinx
ひとりsphinxひとりsphinx
ひとりsphinx
 
ドキュメントの継続的改善―Sphinxを使いながら
ドキュメントの継続的改善―Sphinxを使いながらドキュメントの継続的改善―Sphinxを使いながら
ドキュメントの継続的改善―Sphinxを使いながら
 
ユーザ・デザイナーから見たPlone CMSのアピールポイント
ユーザ・デザイナーから見たPlone CMSのアピールポイントユーザ・デザイナーから見たPlone CMSのアピールポイント
ユーザ・デザイナーから見たPlone CMSのアピールポイント
 
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまで
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまでSphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまで
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまで
 
個人的ドキュメンテーションツール トップ100
個人的ドキュメンテーションツール トップ100個人的ドキュメンテーションツール トップ100
個人的ドキュメンテーションツール トップ100
 
マークアップ言語の拡張 メリットとデメリット #hankumi
マークアップ言語の拡張 メリットとデメリット #hankumiマークアップ言語の拡張 メリットとデメリット #hankumi
マークアップ言語の拡張 メリットとデメリット #hankumi
 
ドキュメントを加速する作画ツール Blockdiag 2011/07 #infotalk
ドキュメントを加速する作画ツール Blockdiag 2011/07 #infotalkドキュメントを加速する作画ツール Blockdiag 2011/07 #infotalk
ドキュメントを加速する作画ツール Blockdiag 2011/07 #infotalk
 
SIerでもSphinxを使いたい! 前編
SIerでもSphinxを使いたい! 前編SIerでもSphinxを使いたい! 前編
SIerでもSphinxを使いたい! 前編
 
Sphinxの環境構築が再現できない問題をDockerで解決してみた
Sphinxの環境構築が再現できない問題をDockerで解決してみたSphinxの環境構築が再現できない問題をDockerで解決してみた
Sphinxの環境構築が再現できない問題をDockerで解決してみた
 
自社製品のバージョン管理 進化と問題解決の道のり
自社製品のバージョン管理 進化と問題解決の道のり自社製品のバージョン管理 進化と問題解決の道のり
自社製品のバージョン管理 進化と問題解決の道のり
 
xUnitハンズオン第3回テキスト
xUnitハンズオン第3回テキストxUnitハンズオン第3回テキスト
xUnitハンズオン第3回テキスト
 
Pyconjp2016 pyftplib
Pyconjp2016 pyftplibPyconjp2016 pyftplib
Pyconjp2016 pyftplib
 
DevOpsが引き金となるインフラエンジニアの進撃
DevOpsが引き金となるインフラエンジニアの進撃DevOpsが引き金となるインフラエンジニアの進撃
DevOpsが引き金となるインフラエンジニアの進撃
 
Python界隈の翻訳プロジェクト
Python界隈の翻訳プロジェクトPython界隈の翻訳プロジェクト
Python界隈の翻訳プロジェクト
 
Excel 方眼紙撲滅委員会 活動報告 2012.08 #pyfes
Excel 方眼紙撲滅委員会 活動報告 2012.08 #pyfesExcel 方眼紙撲滅委員会 活動報告 2012.08 #pyfes
Excel 方眼紙撲滅委員会 活動報告 2012.08 #pyfes
 
手軽にメンテナンスできるドキュメントのヒミツ - blockdiag #odstudy 2011/07
手軽にメンテナンスできるドキュメントのヒミツ - blockdiag #odstudy 2011/07手軽にメンテナンスできるドキュメントのヒミツ - blockdiag #odstudy 2011/07
手軽にメンテナンスできるドキュメントのヒミツ - blockdiag #odstudy 2011/07
 
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
 
xUnitハンズオン第2回テキスト
xUnitハンズオン第2回テキストxUnitハンズオン第2回テキスト
xUnitハンズオン第2回テキスト
 

More from Takeshi Komiya

ドキュメントの話、しませんか? #428rk01
ドキュメントの話、しませんか? #428rk01ドキュメントの話、しませんか? #428rk01
ドキュメントの話、しませんか? #428rk01Takeshi Komiya
 
個人的なさがしもののはなし #rubyhiroba
個人的なさがしもののはなし #rubyhiroba個人的なさがしもののはなし #rubyhiroba
個人的なさがしもののはなし #rubyhirobaTakeshi Komiya
 
俺の嫁と行った場所 #pykonjp2014
俺の嫁と行った場所 #pykonjp2014俺の嫁と行った場所 #pykonjp2014
俺の嫁と行った場所 #pykonjp2014Takeshi Komiya
 
発見・探検・ぼくのだいあぐ #pykonjp2014
発見・探検・ぼくのだいあぐ #pykonjp2014発見・探検・ぼくのだいあぐ #pykonjp2014
発見・探検・ぼくのだいあぐ #pykonjp2014Takeshi Komiya
 
Excel 方眼紙撲滅委員会 活動報告 2013.9 #yapcasia
Excel 方眼紙撲滅委員会 活動報告 2013.9 #yapcasiaExcel 方眼紙撲滅委員会 活動報告 2013.9 #yapcasia
Excel 方眼紙撲滅委員会 活動報告 2013.9 #yapcasiaTakeshi Komiya
 
Pythonユーザのための構成管理入門 #pyconapac
Pythonユーザのための構成管理入門 #pyconapacPythonユーザのための構成管理入門 #pyconapac
Pythonユーザのための構成管理入門 #pyconapacTakeshi Komiya
 
Chef の気まぐれ環境構築 〜季節の Capistrano を添えて〜 #jawsug
Chef の気まぐれ環境構築 〜季節の Capistrano を添えて〜 #jawsugChef の気まぐれ環境構築 〜季節の Capistrano を添えて〜 #jawsug
Chef の気まぐれ環境構築 〜季節の Capistrano を添えて〜 #jawsugTakeshi Komiya
 
Paratrooper chef の紹介 @ Chef Casual Talks Vol.2 #eytokyo
Paratrooper chef の紹介 @ Chef Casual Talks Vol.2 #eytokyoParatrooper chef の紹介 @ Chef Casual Talks Vol.2 #eytokyo
Paratrooper chef の紹介 @ Chef Casual Talks Vol.2 #eytokyoTakeshi Komiya
 
明日から始める Chef 入門 #bpstudy
明日から始める Chef 入門 #bpstudy明日から始める Chef 入門 #bpstudy
明日から始める Chef 入門 #bpstudyTakeshi Komiya
 
Roundsmanの紹介 @ Chef Casual Talks Vol.1 #eytokyo
Roundsmanの紹介 @ Chef Casual Talks Vol.1 #eytokyo Roundsmanの紹介 @ Chef Casual Talks Vol.1 #eytokyo
Roundsmanの紹介 @ Chef Casual Talks Vol.1 #eytokyo Takeshi Komiya
 
春を先取り!OpsWorksとChef ではじめる恋色コーデ術! #pyfes 2013.03
春を先取り!OpsWorksとChef ではじめる恋色コーデ術! #pyfes 2013.03春を先取り!OpsWorksとChef ではじめる恋色コーデ術! #pyfes 2013.03
春を先取り!OpsWorksとChef ではじめる恋色コーデ術! #pyfes 2013.03Takeshi Komiya
 
Inside of excel 方眼紙撲滅委員会 #pyfes
Inside of excel 方眼紙撲滅委員会 #pyfesInside of excel 方眼紙撲滅委員会 #pyfes
Inside of excel 方眼紙撲滅委員会 #pyfesTakeshi Komiya
 
Excel 方眼紙撲滅委員会 活動報告 2012.11 #odstudy
Excel 方眼紙撲滅委員会 活動報告 2012.11 #odstudyExcel 方眼紙撲滅委員会 活動報告 2012.11 #odstudy
Excel 方眼紙撲滅委員会 活動報告 2012.11 #odstudyTakeshi Komiya
 
Life with Sphinx 2012 #sphinxconjp
Life with Sphinx 2012 #sphinxconjpLife with Sphinx 2012 #sphinxconjp
Life with Sphinx 2012 #sphinxconjpTakeshi Komiya
 
Excel 方眼紙撲滅委員会 活動報告 2012.09 #yapcasia #ltthon
Excel 方眼紙撲滅委員会 活動報告 2012.09 #yapcasia #ltthonExcel 方眼紙撲滅委員会 活動報告 2012.09 #yapcasia #ltthon
Excel 方眼紙撲滅委員会 活動報告 2012.09 #yapcasia #ltthonTakeshi Komiya
 
Excel 方眼紙撲滅委員会 活動報告 2012.09 #pyconjp
Excel 方眼紙撲滅委員会 活動報告 2012.09 #pyconjpExcel 方眼紙撲滅委員会 活動報告 2012.09 #pyconjp
Excel 方眼紙撲滅委員会 活動報告 2012.09 #pyconjpTakeshi Komiya
 
最近つくった Sphinx 拡張の話 2012.08 #pyfes
最近つくった Sphinx 拡張の話 2012.08 #pyfes最近つくった Sphinx 拡張の話 2012.08 #pyfes
最近つくった Sphinx 拡張の話 2012.08 #pyfesTakeshi Komiya
 
五番目のダイアグ、現る。 2012.08 #pyfes #blockdiag
五番目のダイアグ、現る。 2012.08 #pyfes #blockdiag五番目のダイアグ、現る。 2012.08 #pyfes #blockdiag
五番目のダイアグ、現る。 2012.08 #pyfes #blockdiagTakeshi Komiya
 
3分間 開発環境クッキング 2012.07 #pyfes
3分間 開発環境クッキング 2012.07 #pyfes3分間 開発環境クッキング 2012.07 #pyfes
3分間 開発環境クッキング 2012.07 #pyfesTakeshi Komiya
 
blockdiagの最新動向 2011.11 #odstudy
blockdiagの最新動向 2011.11 #odstudyblockdiagの最新動向 2011.11 #odstudy
blockdiagの最新動向 2011.11 #odstudyTakeshi Komiya
 

More from Takeshi Komiya (20)

ドキュメントの話、しませんか? #428rk01
ドキュメントの話、しませんか? #428rk01ドキュメントの話、しませんか? #428rk01
ドキュメントの話、しませんか? #428rk01
 
個人的なさがしもののはなし #rubyhiroba
個人的なさがしもののはなし #rubyhiroba個人的なさがしもののはなし #rubyhiroba
個人的なさがしもののはなし #rubyhiroba
 
俺の嫁と行った場所 #pykonjp2014
俺の嫁と行った場所 #pykonjp2014俺の嫁と行った場所 #pykonjp2014
俺の嫁と行った場所 #pykonjp2014
 
発見・探検・ぼくのだいあぐ #pykonjp2014
発見・探検・ぼくのだいあぐ #pykonjp2014発見・探検・ぼくのだいあぐ #pykonjp2014
発見・探検・ぼくのだいあぐ #pykonjp2014
 
Excel 方眼紙撲滅委員会 活動報告 2013.9 #yapcasia
Excel 方眼紙撲滅委員会 活動報告 2013.9 #yapcasiaExcel 方眼紙撲滅委員会 活動報告 2013.9 #yapcasia
Excel 方眼紙撲滅委員会 活動報告 2013.9 #yapcasia
 
Pythonユーザのための構成管理入門 #pyconapac
Pythonユーザのための構成管理入門 #pyconapacPythonユーザのための構成管理入門 #pyconapac
Pythonユーザのための構成管理入門 #pyconapac
 
Chef の気まぐれ環境構築 〜季節の Capistrano を添えて〜 #jawsug
Chef の気まぐれ環境構築 〜季節の Capistrano を添えて〜 #jawsugChef の気まぐれ環境構築 〜季節の Capistrano を添えて〜 #jawsug
Chef の気まぐれ環境構築 〜季節の Capistrano を添えて〜 #jawsug
 
Paratrooper chef の紹介 @ Chef Casual Talks Vol.2 #eytokyo
Paratrooper chef の紹介 @ Chef Casual Talks Vol.2 #eytokyoParatrooper chef の紹介 @ Chef Casual Talks Vol.2 #eytokyo
Paratrooper chef の紹介 @ Chef Casual Talks Vol.2 #eytokyo
 
明日から始める Chef 入門 #bpstudy
明日から始める Chef 入門 #bpstudy明日から始める Chef 入門 #bpstudy
明日から始める Chef 入門 #bpstudy
 
Roundsmanの紹介 @ Chef Casual Talks Vol.1 #eytokyo
Roundsmanの紹介 @ Chef Casual Talks Vol.1 #eytokyo Roundsmanの紹介 @ Chef Casual Talks Vol.1 #eytokyo
Roundsmanの紹介 @ Chef Casual Talks Vol.1 #eytokyo
 
春を先取り!OpsWorksとChef ではじめる恋色コーデ術! #pyfes 2013.03
春を先取り!OpsWorksとChef ではじめる恋色コーデ術! #pyfes 2013.03春を先取り!OpsWorksとChef ではじめる恋色コーデ術! #pyfes 2013.03
春を先取り!OpsWorksとChef ではじめる恋色コーデ術! #pyfes 2013.03
 
Inside of excel 方眼紙撲滅委員会 #pyfes
Inside of excel 方眼紙撲滅委員会 #pyfesInside of excel 方眼紙撲滅委員会 #pyfes
Inside of excel 方眼紙撲滅委員会 #pyfes
 
Excel 方眼紙撲滅委員会 活動報告 2012.11 #odstudy
Excel 方眼紙撲滅委員会 活動報告 2012.11 #odstudyExcel 方眼紙撲滅委員会 活動報告 2012.11 #odstudy
Excel 方眼紙撲滅委員会 活動報告 2012.11 #odstudy
 
Life with Sphinx 2012 #sphinxconjp
Life with Sphinx 2012 #sphinxconjpLife with Sphinx 2012 #sphinxconjp
Life with Sphinx 2012 #sphinxconjp
 
Excel 方眼紙撲滅委員会 活動報告 2012.09 #yapcasia #ltthon
Excel 方眼紙撲滅委員会 活動報告 2012.09 #yapcasia #ltthonExcel 方眼紙撲滅委員会 活動報告 2012.09 #yapcasia #ltthon
Excel 方眼紙撲滅委員会 活動報告 2012.09 #yapcasia #ltthon
 
Excel 方眼紙撲滅委員会 活動報告 2012.09 #pyconjp
Excel 方眼紙撲滅委員会 活動報告 2012.09 #pyconjpExcel 方眼紙撲滅委員会 活動報告 2012.09 #pyconjp
Excel 方眼紙撲滅委員会 活動報告 2012.09 #pyconjp
 
最近つくった Sphinx 拡張の話 2012.08 #pyfes
最近つくった Sphinx 拡張の話 2012.08 #pyfes最近つくった Sphinx 拡張の話 2012.08 #pyfes
最近つくった Sphinx 拡張の話 2012.08 #pyfes
 
五番目のダイアグ、現る。 2012.08 #pyfes #blockdiag
五番目のダイアグ、現る。 2012.08 #pyfes #blockdiag五番目のダイアグ、現る。 2012.08 #pyfes #blockdiag
五番目のダイアグ、現る。 2012.08 #pyfes #blockdiag
 
3分間 開発環境クッキング 2012.07 #pyfes
3分間 開発環境クッキング 2012.07 #pyfes3分間 開発環境クッキング 2012.07 #pyfes
3分間 開発環境クッキング 2012.07 #pyfes
 
blockdiagの最新動向 2011.11 #odstudy
blockdiagの最新動向 2011.11 #odstudyblockdiagの最新動向 2011.11 #odstudy
blockdiagの最新動向 2011.11 #odstudy
 

Recently uploaded

PHP-Conference-Odawara-2024-04-000000000
PHP-Conference-Odawara-2024-04-000000000PHP-Conference-Odawara-2024-04-000000000
PHP-Conference-Odawara-2024-04-000000000Shota Ito
 
プレイマットのパターン生成支援ツール
プレイマットのパターン生成支援ツールプレイマットのパターン生成支援ツール
プレイマットのパターン生成支援ツールsugiuralab
 
プレイマットのパターン生成支援ツールの評価
プレイマットのパターン生成支援ツールの評価プレイマットのパターン生成支援ツールの評価
プレイマットのパターン生成支援ツールの評価sugiuralab
 
新人研修のまとめ 2024/04/12の勉強会で発表されたものです。
新人研修のまとめ       2024/04/12の勉強会で発表されたものです。新人研修のまとめ       2024/04/12の勉強会で発表されたものです。
新人研修のまとめ 2024/04/12の勉強会で発表されたものです。iPride Co., Ltd.
 
Amazon SES を勉強してみる その12024/04/12の勉強会で発表されたものです。
Amazon SES を勉強してみる その12024/04/12の勉強会で発表されたものです。Amazon SES を勉強してみる その12024/04/12の勉強会で発表されたものです。
Amazon SES を勉強してみる その12024/04/12の勉強会で発表されたものです。iPride Co., Ltd.
 
20240412_HCCJP での Windows Server 2025 Active Directory
20240412_HCCJP での Windows Server 2025 Active Directory20240412_HCCJP での Windows Server 2025 Active Directory
20240412_HCCJP での Windows Server 2025 Active Directoryosamut
 
IoT in the era of generative AI, Thanks IoT ALGYAN.pptx
IoT in the era of generative AI, Thanks IoT ALGYAN.pptxIoT in the era of generative AI, Thanks IoT ALGYAN.pptx
IoT in the era of generative AI, Thanks IoT ALGYAN.pptxAtomu Hidaka
 

Recently uploaded (7)

PHP-Conference-Odawara-2024-04-000000000
PHP-Conference-Odawara-2024-04-000000000PHP-Conference-Odawara-2024-04-000000000
PHP-Conference-Odawara-2024-04-000000000
 
プレイマットのパターン生成支援ツール
プレイマットのパターン生成支援ツールプレイマットのパターン生成支援ツール
プレイマットのパターン生成支援ツール
 
プレイマットのパターン生成支援ツールの評価
プレイマットのパターン生成支援ツールの評価プレイマットのパターン生成支援ツールの評価
プレイマットのパターン生成支援ツールの評価
 
新人研修のまとめ 2024/04/12の勉強会で発表されたものです。
新人研修のまとめ       2024/04/12の勉強会で発表されたものです。新人研修のまとめ       2024/04/12の勉強会で発表されたものです。
新人研修のまとめ 2024/04/12の勉強会で発表されたものです。
 
Amazon SES を勉強してみる その12024/04/12の勉強会で発表されたものです。
Amazon SES を勉強してみる その12024/04/12の勉強会で発表されたものです。Amazon SES を勉強してみる その12024/04/12の勉強会で発表されたものです。
Amazon SES を勉強してみる その12024/04/12の勉強会で発表されたものです。
 
20240412_HCCJP での Windows Server 2025 Active Directory
20240412_HCCJP での Windows Server 2025 Active Directory20240412_HCCJP での Windows Server 2025 Active Directory
20240412_HCCJP での Windows Server 2025 Active Directory
 
IoT in the era of generative AI, Thanks IoT ALGYAN.pptx
IoT in the era of generative AI, Thanks IoT ALGYAN.pptxIoT in the era of generative AI, Thanks IoT ALGYAN.pptx
IoT in the era of generative AI, Thanks IoT ALGYAN.pptx
 

Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp

  • 1. Sphinx-users.jp 小宮健
  • 2. お前だれよ Twitter: @tk0miya  仕事  (株)タイムインターメディア所属  テクニカルオフィサ(技術責任者)として活動  参加コミュニティ  Sphinx-users.jp  Python mini hack-a-thon  Sphinx を中心にツールを開発  blockdiag シリーズ  Sphinx 拡張機能の開発  Googlechart やカレンダー機能  #bookathon 他読書会やってます
  • 3. 祝!SphinxConJP 2012 開催!  世界ではじめてのSphinxカンファレンスへよ うこそ  7件の発表  明日の Sprint Day でもなにかやります  Enjoy Sphinx :-)
  • 4. アンケート  Sphinx 使っていますか? 1. 初めて聞いた 2. 名前は聞いたことはある 3. インストールはしてみた 4. もう使ってるよ
  • 5. Sphinx-users.jp 小宮健
  • 6. アジェンダ 1. Sphinx について 2. Sphinx の現在 3. Sphinx の未来 4. Sphinx コミュニティの紹介 5. まとめ
  • 7.
  • 8. Sphinx とは?  Georg Brandl 謹製のドキュメントツール  オープンソース (BSD ライセンス)
  • 9. Sphinx の特徴  テキストから各種フォーマットへの変換  HTML, PDF など多くのフォーマットに対 応
  • 11. Sphinx の特徴  シンプルなマークアップ  reST (reSTructured Text)  Wiki 記法みたいなもの ====== 見出し ====== * 箇条書き * 箇条書き  目次(toctree)ベースで文書構造を作る
  • 12. Sphinx のよいところ  ソースがテキスト形式  環境/エディタを選ばない  バージョン管理できる  ツールで自動生成しやすい  例) schema2rst (DB定義抽出)  機能を拡張することが出来る  Sphinx 拡張やテーマで表現力アップ  目次(toctree)ベースなので文章が書きやすい
  • 13. Sphinx のいまいちなところ  変換する必要がある  reST を書いて make する、の繰り返し  ツールを使って自動化できるが…  reST は文書レイアウトを表現できない  右寄せ、センタリング、二段組などの表現が ない  割り切りが必要  画像や図などは別途作る必要がある  Office スイートになれていると、ちょっと不 便 :-(
  • 14. Sphinx の主な用途  開発ドキュメント  Python 等 OSS のドキュメント  設計書、マニュアルなど  Web サイト  ブログ風、コーポレートサイト  出版  エキスパート Python プログラミング  Python プロフェッショナルプログラミング  その他多数
  • 15. 他のツールとの比較  Word  ◯ 縦書き表記ができる  ◯ 日本語の文法チェック機能がある  ◯ 変更履歴の管理がしやすい  ◯ 画像や図の差し込みが簡単  ✕ 文書構成をいじるのが大変  ✕ 複数人で管理するのもやりづらい  ✕ Office スイートが必要
  • 16. 他のツールとの比較  Excel  ◯ 誰でも使える。事実上の標準ツール  ◯ 方眼紙ライクな図、説明が書きやすい  ✕ 文章構成が存在しない  ✕ 編集、とくにセルの調整を始めると…  ✕ 印刷しづらいドキュメントができる  ✕ Office スイートが必要
  • 17. 他のツールとの比較  Wiki  ◯ ブラウザだけで編集できる  ◯ 記法がわかりやすく書きやすい  ✕ 図や画像は別途作成する必要がある  ✕ 構成がネットワーク状で迷子になりやす い  ✕ 文書レイアウトは指定しづらい(できな い)
  • 18.
  • 19. 他のツールとの比較  Sphinx-users.jp コンテンツの拡充  readthedocs の登場  日本語 PDF 環境の整備  Sphinx 拡張の増加  Sphinx テーマの増加  利用事例の増加
  • 20. Sphinx-users.jp コンテンツの拡充  http://sphinx-users.jp/  初心者向けコンテンツ  Tips 集  PDF 出力やテーマ  各種拡張の紹介  逆引き辞典  イベント情報
  • 21. readthedocs の登場  Sphinx ドキュメントのホスティングサー ビス  ドキュメントをビルド、公開してくれる  GitHub や BitBucket などにコミットする だけ  文章を書いて公開するのが簡単に
  • 22. 日本語 PDF 環境の整備  日本語 PDF は環境設定が大変だった  打田さんの手によって環境が整ってきた 1. Sphinx にパッチを当てる 2. TeXLive (2011以降)を入れる 3. conf.py をいじる 4. make latexpdfja を実行する  パッチは本家への取り込みを申請中  詳細な手順は sphinx-users.jp で!
  • 23. Sphinx 拡張の増加  様々なメディアに対応する拡張  Youtube, Slideshare, Google Maps  図形を簡単に書くための拡張  blockdiag, seqdiag, plantuml  reST を書きやすくする拡張  wikitable, japanesesupport  その他  テーマ追加、装飾追加(取り消し線、赤字な ど)
  • 24. Sphinx テーマの増加  theme.core 拡張によりテーマの追加が可能 に  スライド系のテーマ  S6 (sphinxjp.themes.s6)  htmlslide (sphinxjp.themes.htmlslide)  impressjs (sphinxjp.themes.impressjs)  格好いいテーマ  bizstyle (sphinxjp.themes.bizstyle)  Solarized (sphinxjp.themes.solarized)
  • 25. 利用事例の増加  OSS での利用は順調に増加  Python 本体、様々なライブラリ  Python 以外でも利用され始めている  Symphony2, CakePHP  伝聞では、業務での利用が増えている  社内では HTML で共有  PDF に変換して納品  コーポレートサイトに利用されている例 も!
  • 26.
  • 27. Sphinx の未来  日本語 PDF のパッチ取り込み  標準で PDF が生成できるように  本家にはたらきかけていく  変換の自動化  Jenkins での変換/公開を簡単にしたい  PDF テーマ  PDF 出力した時の見栄えを変更したい  TeX の知識がなくても変更できるように
  • 28. Sphinx の未来  テーマや拡張をさらに増やす  まだ表現できないものも多い  画像など手間のかかるものもある  選択肢と自由度を上げていきたい  Sphinx Web エディタ  ブラウザだけで文章を編集したい  より Wiki の手軽さに近づけていく  利用事例  仕事で使えると幸せになれるはず!
  • 29. Sphinx の未来  今日の SphinxCon は未来への第一歩  扱っているテーマ  Sphinx 拡張 探訪 (拡張)  Sphinx HTML theme 事始め (テーマ)  Sphinx を使って本を書こう (自動化)  Sphinx の平凡な使い方 (利用事例)  社内での Sphinx、reST の広め方 (利用事例)  Sphinx におけるdocutils の役割(Webエディタ 他)
  • 30.
  • 31. Sphinx-users.jp  Sphinx コミュニティの運営  メーリングリスト  Twitter (#sphinxjp)  サイトの運営、マニュアルの翻訳  イベント開催  Sphinx+翻訳 Hack-a-thon (東京)  Sphinx 朝会 (大阪)  Sphinx ハンズオン  SphinxCon JP 2012
  • 32. Sphinx で困ったら…  Sphinx-users.jp に相談してください  Twitter、ML、イベントなんでも構いませ ん  質問してみる  回答してみる  共有する
  • 33. イベント開催予定  SphinxCon Sprint  9/17(月) PyCon Sprint 会場で開催  ハンズオンもしくは Sprint をやります  Sphinx+翻訳 Hack-a-thon  10/13(土) タイムインターメディア社で開催  Connpass に募集ページあり  Hack-a-thon スタイル、雑談の場
  • 34.
  • 35. まとめ  Sphinx について  Sphinx の現在  Sphinx の未来  Sphinx コミュニティの紹介  Sphinx+翻訳 Hack-a-thon 10月もやるよ  Enjoy Documentation!