Read the Docs(Sphinx)でオープンソースのドキュメントをいい感じに書いてみる

B! 138 0 0 0 最近良くGitHubなんかで公開されてるオープンソースのドキュメントを見ようとすると こんな感じの似たようなフォーマットで書かれているものが多くなっています。 余りに多いので最初GitHubのサービスかな、とか思ったんですが、 これはまた別のRead the Docsという ドキュメント用ホスティングサービスによるものでした。 Read the Docs Read the Docsでドキュメントを公開してみる Sphinxのインストール レポジトリ側の準備 Read the Docsへの登録 ページを作成 Indexページ ページ内容の編集(Markdown to reStructuredText) タイトル ハイパーリンク 画像 リンク付き画像 インラインマークアップ コードブロック リスト テーブル Pythonのモジュール説明 その他reStructured

[s_mori]

read the docs

[tokida]

Read the Docsでオープンソースのドキュメントをいい感じに書いてみる - | 最近良くGitHubなんかで公開されてるオープンソースのドキュメントを見ようとすると こんな感じの似たようなフォーマットで書…

[vanbraam]

こういうstartupのサービスでも日本語含めたm17n,i18nが既に行われている事に驚いた;やはりベースはSphinxなのか.日本と海外のSphinx人気の違いを感じる.SphinxというよりPythonの人気の差かもしれないが

[blue1st]

何か共通のテンプレートでもあるのかなーて気になってたんだけど、あれってそういうサービスだったのね

[karaage]

あ、これ調べようと思ってたやつ