参加するには？¶
#sphinxjpではメーリングリストへの参加＝コミュニティへの参加とみなします。入会金や会費などは一切かかりません。
参加に際しては sphinx-users.jp 会則 を確認して下さい。
必要なスキルは？¶
よく誤解される内容として「SphinxはPython(パイソン)というプログラミング言語で書かれているから、Pythonを知らないと使いこなせない」というものがあります。
Sphinxは確かにPythonで書かれていますが、Sphinxの拡張機能を作ったり、Sphinx本体のバグ修正や機能拡張をしたいと思わない限りは不要です。下記に、コミュニティで活動したい内容ごとの必要なスキルをまとめます。
ここで挙げた各種知識や能力などは一つの目安です。コミュニティでの活動を通じて、これから学ぶことも可能ですが、熱意と勇気は事前にご用意いただく必要があります。
| 何がしたいか？ | 必要なスキル |
|---|---|
| ドキュメント作成の情報交換がしたい |
|
| 翻訳に関する情報交換がしてみたい。 |
|
| Sphinxの拡張機能が作りたい | |
| #sphinxjpのサイトの間違いを見つけたので訂正したい |
|
| 自分のノウハウを#sphinxのサイトに公開したい |
|
| 採用事例に自分の例も追加して欲しい |
|
脚注
| [1] | 現状ではSphinxのソースや、Docutilsの英語資料を読む必要があります。 |
| [2] | 作ったら世界に公開しましょう！英語の確認などはメンバー間で協力することもできます。 |
| [3] | 詳しい説明は Bitbucket に書かれています。 |
コミュニケーション¶
Sphinx-Users.jpでコミュニティとして用意しているコミュニケーションチャンネルは下記の通りです。
メーリングリスト¶
Sphinx-Users.jpでは、python.jpのサーバをお借りしてメーリングリストを運用しています。日本語で投稿できますので、Sphinxの使い方の質問、PR、ご意見などに活用ください。
メーリングリストとしては Sphinx開発元のML(英語) もあります。こちらはSphinx-Users.jpの運営ではありませんが、拡張機能を開発した場合のPRなどはこちらでも行う方が良いでしょう。
Twitter¶
Sphinx-Users.jpの公式ハッシュタグは #sphinxjp です。このハッシュタグを付けて呟いたり、質問をすると、メンバーから回答があるかもしれません。ただし、Twitterの場合は流量が多いと流れてしまうため、質問する場合にはメーリングリストの方が確実です。
Sphinx-Users.jpの情報を呟く @sphinxjp 公式アカウントもあります。
Answer¶
石本さん(@atsuoishimoto)の管理されている、 pythonpath.jpのAnswer を公式の質問サイトとします。MLで聞くのはコワイという方は、 sphinx ハッシュタグを付けて、こちらもご利用ください。
Bitbucket¶
Bitbucketはソースコード管理システム上に作られたSNSです。Sphinx-Users.jpのウェブサイトもSphinxで作成されていますが、 このソースコードはすべてBitbucket に載っています。ここにコミットすると、毎時0分にsphinx-users.jpのウェブサイト上でビルドされてウェブが更新されます。
Sphinx-Users.jpのウェブサイトにドキュメントを掲載したい場合には、MLなどで表明してもらえれば、コミット権を提供することもできますし、Sphinx-Users.jpのウェブサイトのリポジトリをフォークして、自分のリポジトリ上で編集を加えてから、pull-requestを投げることも可能です。
Pull Requestというのは、「こういう修正したから、本家の方で取り込んでください」という依頼を投げる仕組みです。もちろん、メールで通知することもできますが、BitbucketのPull Requestの仕組みを使うと、取り込み側は1ボタンで取り込むことができるというメリットがあります。今後のオープンソースの開発のスタンダードとなりうるワークフローです。
ノート
Bitbucketのドキュメントの日本語訳 もあります。