Sphinx-users.jp のサイト更新方法

Sphinx-users.jp山田剛

World Plone Day 2017 Tokyo

おまえ誰よ

Go YAMADAこの4月に転職して雑用ジニアからインフラエンジニアになりました

最近の仕事

AWS をひたすら調べる毎日

好きな Linux ディストリ

Gentoo 教 systemd 派

最近の悩み

Windowsデスクトップ愛好家がTouch Bar 付き Mac を渡されて困惑

コミュニティ

Sphinx-Users.JP

Python mini hack-a-thon

2

usaturn

会社の宣伝( UNCORVER TRUTH)

LCCのバニラエアは、いかにして「半年で数億円」のWeb改善を実現したのかhttp://www.sbbit.jp/article/bitsp/33166

ユーザーの行動が手に取るようにわかるのがUSERDIVEhttp://news.uncovertruth.co.jp/cases_20150430_1/

Sphinx-Users.JP

「Sphinx」というPythonのドキュメンテーションツールのユーザ会で活動しています。

4

絶賛改訂中！

Sphinx とは

公式サイト:

http://www.sphinx-doc.org/en/stable/

作者: Georg Brandl

静的 HTML を出力します

ベース技術: doctuils 等

特徴: reStructuredtxt や Markdown でマークアップしソースコードを作成。このソースコードを色々なフォーマットで出力できます。

マルチインプット/マルチアウトプット

マルチインプット/マルチアウトプット

インプット Sphinx アウトプット

reST

Markdown

jpeg,png...

Excel

html

PowerPoint

HTMLman

PDF

ePub3

LaTeX

text

csv

gettext

json

自分が気に入っているところ

ドキュメントのソースコードがプレーンテキストなのでプログラムのソースコードと同じように扱えるという事

本体、サードパーティ製を問わず拡張が多い事

自分がイマイチと思っているところ

完成した GUI ツールが存在しない事

初学者に勧めにくい

reStructuredtxt の実装が(たぶん) Python の docutils しかない事

他の言語での実装が出てこない

Sphinx-users.jp(ユーザサイト)

ユーザサイトの公開先 AWS の s3 で静的 Web サイトとして公開されています。

Sphinx-users.jp 更新の流れ

1. Sphinx-users.jp プロジェクトを編集しGitHub へ push

2. wercker がビルドを実行

3. ビルド完了後、 wercker の s3sync でs3 へアップロード

4. サイト更新完了

GitHub へ push --> wercker

1. Sphinx-users.jp プロジェクトを編集し commit

2. GitHub へ push

3. GitHub の webhook から wercker がビルドを開始

GitHub の webhook から wercker

ビルドが終わったら wercker の s3sync で s3 にアップロード

サイト更新以外の処理

sphinjp の slack へ通知

GitHub の webhook から slack notification

wercker で使っている docker コンテナをビルド

GitHub の integrations & service の設定

https://hub.docker.com/r/sphinxjp/sphinx-users.jp/

以上

ご清聴ありがとうございました