Submit Search
Upload
Sphinx で手軽に作るドキュメント
•
Download as PPTX, PDF
•
3 likes
•
9,455 views
Go Yamada
Follow
SphinxCon 2015 の発表内容です。
Read less
Read more
Software
Report
Share
Report
Share
1 of 20
Download now
Recommended
Sphinx GO!!
Sphinx GO!!
Go Yamada
BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版
BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版
Go Yamada
ひとりsphinx
ひとりsphinx
(^-^) togakushi
執筆中のPythonプロフェッショナルプログラミング第2版でsphinxを使っている話
執筆中のPythonプロフェッショナルプログラミング第2版でsphinxを使っている話
Takayuki Shimizukawa
手軽にメンテナンスできるドキュメントのヒミツ - blockdiag #odstudy 2011/07
手軽にメンテナンスできるドキュメントのヒミツ - blockdiag #odstudy 2011/07
Takeshi Komiya
個人的ドキュメンテーションツール トップ100
個人的ドキュメンテーションツール トップ100
Go Yamada
Oktavia全文検索エンジン - SphinxCon JP 2014
Oktavia全文検索エンジン - SphinxCon JP 2014
Yoshiki Shibukawa
JUS関西 Sphinxワークショップ@関西 Sphinx紹介
JUS関西 Sphinxワークショップ@関西 Sphinx紹介
Takayuki Shimizukawa
Recommended
Sphinx GO!!
Sphinx GO!!
Go Yamada
BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版
BPstudy#64 ドキュメントを作りたくなってしまう魔法のツール Sphinx 2012年版
Go Yamada
ひとりsphinx
ひとりsphinx
(^-^) togakushi
執筆中のPythonプロフェッショナルプログラミング第2版でsphinxを使っている話
執筆中のPythonプロフェッショナルプログラミング第2版でsphinxを使っている話
Takayuki Shimizukawa
手軽にメンテナンスできるドキュメントのヒミツ - blockdiag #odstudy 2011/07
手軽にメンテナンスできるドキュメントのヒミツ - blockdiag #odstudy 2011/07
Takeshi Komiya
個人的ドキュメンテーションツール トップ100
個人的ドキュメンテーションツール トップ100
Go Yamada
Oktavia全文検索エンジン - SphinxCon JP 2014
Oktavia全文検索エンジン - SphinxCon JP 2014
Yoshiki Shibukawa
JUS関西 Sphinxワークショップ@関西 Sphinx紹介
JUS関西 Sphinxワークショップ@関西 Sphinx紹介
Takayuki Shimizukawa
sphinx + blockdiag で始めるドキュメント生活 2011/05 yokohama.pm
sphinx + blockdiag で始めるドキュメント生活 2011/05 yokohama.pm
Takeshi Komiya
APIドキュメントの話 #sphinxjp
APIドキュメントの話 #sphinxjp
Takeshi Komiya
Sphinx customization for OGP support at SphinxCon JP 2018
Sphinx customization for OGP support at SphinxCon JP 2018
Takayuki Shimizukawa
Sphinxの使い方事例
Sphinxの使い方事例
Go Yamada
社内のマニュアルをSphinxで作ってみた
社内のマニュアルをSphinxで作ってみた
Iosif Takakura
マークアップ言語の拡張 メリットとデメリット #hankumi
マークアップ言語の拡張 メリットとデメリット #hankumi
Takeshi Komiya
Sphinx拡張 探訪 2014 #sphinxjp
Sphinx拡張 探訪 2014 #sphinxjp
Takeshi Komiya
SIerでもSphinxを使いたい! 前編
SIerでもSphinxを使いたい! 前編
kk_Ataka
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
Takeshi Komiya
Introduce for sphinx-users-jp
Introduce for sphinx-users-jp
Go Yamada
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
kk_Ataka
How to spread reST and Sphinx
How to spread reST and Sphinx
Takanori Suzuki
世界のSphinx事情 @ SphinxCon JP 2015
世界のSphinx事情 @ SphinxCon JP 2015
Takayuki Shimizukawa
ドキュメントの話、しませんか? #428rk01
ドキュメントの話、しませんか? #428rk01
Takeshi Komiya
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
Takayuki Shimizukawa
ドキュメントを加速する作画ツール Blockdiag 2011/07 #infotalk
ドキュメントを加速する作画ツール Blockdiag 2011/07 #infotalk
Takeshi Komiya
Sphinxで社内勉強会(Git)の 資料を作ってみた
Sphinxで社内勉強会(Git)の 資料を作ってみた
Taku SHIMIZU
ドキュメントシステムはこれを使え2015年版
ドキュメントシステムはこれを使え2015年版
Keiichiro Shikano
Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp
Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp
Takeshi Komiya
Sphinxを使って本を書こう #pyconjp 2012
Sphinxを使って本を書こう #pyconjp 2012
Takayuki Shimizukawa
Markdownもはじめよう
Markdownもはじめよう
masayoshi takahashi
Sphinx HTML Theme Hacks
Sphinx HTML Theme Hacks
Shoji KUMAGAI
More Related Content
What's hot
sphinx + blockdiag で始めるドキュメント生活 2011/05 yokohama.pm
sphinx + blockdiag で始めるドキュメント生活 2011/05 yokohama.pm
Takeshi Komiya
APIドキュメントの話 #sphinxjp
APIドキュメントの話 #sphinxjp
Takeshi Komiya
Sphinx customization for OGP support at SphinxCon JP 2018
Sphinx customization for OGP support at SphinxCon JP 2018
Takayuki Shimizukawa
Sphinxの使い方事例
Sphinxの使い方事例
Go Yamada
社内のマニュアルをSphinxで作ってみた
社内のマニュアルをSphinxで作ってみた
Iosif Takakura
マークアップ言語の拡張 メリットとデメリット #hankumi
マークアップ言語の拡張 メリットとデメリット #hankumi
Takeshi Komiya
Sphinx拡張 探訪 2014 #sphinxjp
Sphinx拡張 探訪 2014 #sphinxjp
Takeshi Komiya
SIerでもSphinxを使いたい! 前編
SIerでもSphinxを使いたい! 前編
kk_Ataka
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
Takeshi Komiya
Introduce for sphinx-users-jp
Introduce for sphinx-users-jp
Go Yamada
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
kk_Ataka
How to spread reST and Sphinx
How to spread reST and Sphinx
Takanori Suzuki
世界のSphinx事情 @ SphinxCon JP 2015
世界のSphinx事情 @ SphinxCon JP 2015
Takayuki Shimizukawa
ドキュメントの話、しませんか? #428rk01
ドキュメントの話、しませんか? #428rk01
Takeshi Komiya
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
Takayuki Shimizukawa
ドキュメントを加速する作画ツール Blockdiag 2011/07 #infotalk
ドキュメントを加速する作画ツール Blockdiag 2011/07 #infotalk
Takeshi Komiya
Sphinxで社内勉強会(Git)の 資料を作ってみた
Sphinxで社内勉強会(Git)の 資料を作ってみた
Taku SHIMIZU
ドキュメントシステムはこれを使え2015年版
ドキュメントシステムはこれを使え2015年版
Keiichiro Shikano
Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp
Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp
Takeshi Komiya
Sphinxを使って本を書こう #pyconjp 2012
Sphinxを使って本を書こう #pyconjp 2012
Takayuki Shimizukawa
What's hot
(20)
sphinx + blockdiag で始めるドキュメント生活 2011/05 yokohama.pm
sphinx + blockdiag で始めるドキュメント生活 2011/05 yokohama.pm
APIドキュメントの話 #sphinxjp
APIドキュメントの話 #sphinxjp
Sphinx customization for OGP support at SphinxCon JP 2018
Sphinx customization for OGP support at SphinxCon JP 2018
Sphinxの使い方事例
Sphinxの使い方事例
社内のマニュアルをSphinxで作ってみた
社内のマニュアルをSphinxで作ってみた
マークアップ言語の拡張 メリットとデメリット #hankumi
マークアップ言語の拡張 メリットとデメリット #hankumi
Sphinx拡張 探訪 2014 #sphinxjp
Sphinx拡張 探訪 2014 #sphinxjp
SIerでもSphinxを使いたい! 前編
SIerでもSphinxを使いたい! 前編
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
Sphinx ではじめるドキュメント生活 2013 #sphinxconjp
Introduce for sphinx-users-jp
Introduce for sphinx-users-jp
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
How to spread reST and Sphinx
How to spread reST and Sphinx
世界のSphinx事情 @ SphinxCon JP 2015
世界のSphinx事情 @ SphinxCon JP 2015
ドキュメントの話、しませんか? #428rk01
ドキュメントの話、しませんか? #428rk01
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
ドキュメントを加速する作画ツール Blockdiag 2011/07 #infotalk
ドキュメントを加速する作画ツール Blockdiag 2011/07 #infotalk
Sphinxで社内勉強会(Git)の 資料を作ってみた
Sphinxで社内勉強会(Git)の 資料を作ってみた
ドキュメントシステムはこれを使え2015年版
ドキュメントシステムはこれを使え2015年版
Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp
Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp
Sphinxを使って本を書こう #pyconjp 2012
Sphinxを使って本を書こう #pyconjp 2012
Viewers also liked
Markdownもはじめよう
Markdownもはじめよう
masayoshi takahashi
Sphinx HTML Theme Hacks
Sphinx HTML Theme Hacks
Shoji KUMAGAI
SIerでもSphinxを使いたい!総括
SIerでもSphinxを使いたい!総括
kk_Ataka
やりなおせる Git 入門
やりなおせる Git 入門
Tomohiko Himura
もしWordPressユーザーがGitを使ったら 〜WordPressテーマを共同編集しよう〜
もしWordPressユーザーがGitを使ったら 〜WordPressテーマを共同編集しよう〜
Takashi Uemura
ドキュメントを作りたくなってしまう魔法のツールSphinx
ドキュメントを作りたくなってしまう魔法のツールSphinx
Takayuki Shimizukawa
こわくない Git
こわくない Git
Kota Saito
Viewers also liked
(7)
Markdownもはじめよう
Markdownもはじめよう
Sphinx HTML Theme Hacks
Sphinx HTML Theme Hacks
SIerでもSphinxを使いたい!総括
SIerでもSphinxを使いたい!総括
やりなおせる Git 入門
やりなおせる Git 入門
もしWordPressユーザーがGitを使ったら 〜WordPressテーマを共同編集しよう〜
もしWordPressユーザーがGitを使ったら 〜WordPressテーマを共同編集しよう〜
ドキュメントを作りたくなってしまう魔法のツールSphinx
ドキュメントを作りたくなってしまう魔法のツールSphinx
こわくない Git
こわくない Git
Similar to Sphinx で手軽に作るドキュメント
Raindrop
Raindrop
Makoto Kato
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
Yoshiki Shibukawa
Sphinxでドキュメントを書こう
Sphinxでドキュメントを書こう
Kazufumi Ohkawa
Publishing of sphinx2018
Publishing of sphinx2018
Go Yamada
達人出版会のご紹介(技術編)
達人出版会のご紹介(技術編)
masayoshi takahashi
12 総合演習Word Pressの利用
12 総合演習Word Pressの利用
文樹 高橋
ネットワーク図作成ツール nwdiag の紹介 2011/07 #janog28
ネットワーク図作成ツール nwdiag の紹介 2011/07 #janog28
Takeshi Komiya
自社製品のバージョン管理 進化と問題解決の道のり
自社製品のバージョン管理 進化と問題解決の道のり
Study Group by SciencePark Corp.
Don't need docker
Don't need docker
Go Yamada
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまで
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまで
Study Group by SciencePark Corp.
20090828 Webconlocal
20090828 Webconlocal
Kentaro Matsui
邪道Jenkins
邪道Jenkins
hazisarashi
Firebug×smart release20120904
Firebug×smart release20120904
Masayuki Abe
Pyconjp2016 pyftplib
Pyconjp2016 pyftplib
Shinya Okano
社内システムの移行に役立った“時間節約”方法~PowerShellとExcelを上手に使おう
社内システムの移行に役立った“時間節約”方法~PowerShellとExcelを上手に使おう
Satoru Nasu
ユーザ・デザイナーから見たPlone CMSのアピールポイント
ユーザ・デザイナーから見たPlone CMSのアピールポイント
Masaki NIWA
2006-04-22 CLR/H #14 .NET and open source
2006-04-22 CLR/H #14 .NET and open source
Yoshiyuki Nakamura
WebRTC mediasoup on raspberrypi3
WebRTC mediasoup on raspberrypi3
mganeko
Cloudn PaaSチームのChatOps実践
Cloudn PaaSチームのChatOps実践
Kazuto Kusama
XPagesDay 2013 Closing Session
XPagesDay 2013 Closing Session
Atsushi Sato
Similar to Sphinx で手軽に作るドキュメント
(20)
Raindrop
Raindrop
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
ドキュメントを作りたくなってしまう魔法のツール「Sphinx」
Sphinxでドキュメントを書こう
Sphinxでドキュメントを書こう
Publishing of sphinx2018
Publishing of sphinx2018
達人出版会のご紹介(技術編)
達人出版会のご紹介(技術編)
12 総合演習Word Pressの利用
12 総合演習Word Pressの利用
ネットワーク図作成ツール nwdiag の紹介 2011/07 #janog28
ネットワーク図作成ツール nwdiag の紹介 2011/07 #janog28
自社製品のバージョン管理 進化と問題解決の道のり
自社製品のバージョン管理 進化と問題解決の道のり
Don't need docker
Don't need docker
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまで
SphinxのCIの続き Azure DevOpsでのビルド結果を、認証付きAzure App Serviceに公開するところまで
20090828 Webconlocal
20090828 Webconlocal
邪道Jenkins
邪道Jenkins
Firebug×smart release20120904
Firebug×smart release20120904
Pyconjp2016 pyftplib
Pyconjp2016 pyftplib
社内システムの移行に役立った“時間節約”方法~PowerShellとExcelを上手に使おう
社内システムの移行に役立った“時間節約”方法~PowerShellとExcelを上手に使おう
ユーザ・デザイナーから見たPlone CMSのアピールポイント
ユーザ・デザイナーから見たPlone CMSのアピールポイント
2006-04-22 CLR/H #14 .NET and open source
2006-04-22 CLR/H #14 .NET and open source
WebRTC mediasoup on raspberrypi3
WebRTC mediasoup on raspberrypi3
Cloudn PaaSチームのChatOps実践
Cloudn PaaSチームのChatOps実践
XPagesDay 2013 Closing Session
XPagesDay 2013 Closing Session
Sphinx で手軽に作るドキュメント
1.
Sphinx-Users.JP 山田 剛 SphinxCon JP
2015
2.
自己紹介 山田 剛 Web広告配信会社のインフラエンジニア 最近の仕事
サーバの調達からサーバ構築、管理 インフラ系サーバ(DNS、MAIL、Hadoop等)の運用 コミュニティ Python mini hack-a-thon Sphinx-Users.JP 2 Twitter: usaturn
3.
今日お話しする事 既にSphinxを使い始めている方向けに、 日常のメモを取りながらドキュメント を育てる方法をご紹介します。
4.
今日お話ししない事 Sphinxの詳細な使い方 巨大な文書の作り方 複数人作業を主とした文書の作り方
5.
アジェンダ 1. メモを取ろう 2. 再構成しよう 3.
ドキュメントの例 4. この方法の感想と課題 5. まとめ
6.
1. メモを取ろう 2. 再構成しよう 3.
ドキュメントの例 4. この方法の感想と課題 5. まとめ
7.
メモを取ろう 例えば1人プロジェクトが終わったり、 引継ぎをしようとして 「一からドキュメントを書こう」 として途方にくれてしまう事はありま せんか?
8.
メモを取ろう とにかく普段からSphinxプロジェクトの 中にreSTで作成したメモを放り込んでい く 構成等細かい事は気にしない
メモを残す事が大事
9.
メモを取ろう reSTにまだ慣れていなければこれだけでいい セクション 箇条書き toctree
10.
1. メモを取ろう 2. 再構成しよう 3.
ドキュメントの例 4. この方法の感想と課題 5. まとめ
11.
再構成しよう ある程度関連ドキュメントが溜まって きたらまとめどき toctreeやindexを編集する 足りない部分を肉付けする 他のSphinxプロジェクトに分離する
12.
1. メモを取ろう 2. 再構成しよう 3.
ドキュメントの例 4. この方法の感想と課題 5. まとめ
13.
ドキュメントの例
14.
1. メモを取ろう 2. 再構成しよう 3.
ドキュメントの例 4. この方法の感想と課題 5. まとめ
15.
この方法の感想と課題 このやり方が良かったところ 人に見てもらいやすい オレオレマークアップのテキストや Wordを開いて見るより見やすい。 まとまっているのでファイルサーバを 片っ端から漁るより探しやすい 他のSphinxドキュメントにくっつけ る事が容易い
16.
この方法の感想と課題 課題 Sphinxを使ってくれない人と一緒に Sphinxドキュメントを作成する事が できない 他のツール(wikiやWord、オレオレ マークアップ)を利用している人がい たり使い分けを明確にできていない
17.
1. メモを取ろう 2. 再構成しよう 3.
ドキュメントの例 4. この方法の感想と課題 5. まとめ
18.
まとめ 1. 新しいやり方や、初めて知ったtips など片っ端からreSTでメモする 2. 初めに使う記法は「セクション」 「箇条書き」「toctree」だけでも 良い 3.
ドキュメントが溜まってきたら再 編集したり分離したりする
19.
Sphinxをはじめよう!
20.
以上 ご清聴ありがとうございました
Editor's Notes
私たち Sphinx-users.jp の有志は電子書籍「Sphinxをはじめよう」を出版しました
Download now