Sphinx 文書に markdown フォーマットを利用する - Hack like a rolling stone
この記事は Sphinx アドベントカレンダーの 19日目です。 markdown と Sphinx (reST) Sphinx では文書を書く際の記述フォーマットに reStructured Text を利用していますが、 世を広く見回すと、github 然り、bitbucket 然り、様々な場所で markdown フォーマットが利用されています。 markdown フォーマットは reST と比べると表現力が低い上、表現を拡張することができないという点が指摘されています。 表現を拡張することができないため、いくつかの方言が存在するという問題もあります。 ですが、reST と比べてシンプルで、なおかつポピュラーに利用されているフォーマットであるため、 新しく Sphinx に触り始める人の取っ掛かりとしては、markdown はうってつけのフォーマットと言えます。 sphinxcont
MarkdownでSphinxできるようになったので試してみた（後編） - 意識の高いLISPマシン
この記事はドキュメンテーションツールAdvent Calendar (http://www.adventar.org/calendars/1196) の2日目です。 （まだまだ空欄だらけなので、執筆者も募集しています。） この記事は2部構成の2部目です。 1日目：概要の説明 MarkdownでSphinxできるようになったので試してみた（前編） - 意識の高いLISPマシン 2日目：実際に試してみた記録（いまここ） 今回は、実際にSphinxをインストールし、Markdownで文書が作成できるかどうかを試してみます。 なお、元ネタはこのプレゼンです（再掲）。 準備 Mac OS X上で作業。HomebrewでインストールしたPython2を使用します。 最近ターミナルをほったらかしていたので、まずHomebrewを整備します。 $ brew doctor $ brew update $ b
自分用技術メモの作成が捗ったSphinxのあれこれについて - Qiita
はじめに この記事はHamee Advent Calendar 2016の17日目の記事です。 少し前から個人的にSphinx（Python製のドキュメンテーションツール）に触れていて、試しに自分用の技術メモの作成にSphinxを使ってみたら思った以上に捗ったので、その際に使った機能や拡張機能について書いていきます。 注意 この記事ではSphinxの詳細についてはほとんど紹介しません。 あくまでこんな機能・拡張機能を使ったら便利だったよ！といった ポエム 内容の記事となっていますので、あらかじめご了承ください。 TOCツリーのおかげで見通しが良く管理しやすい メモを1つのファイルに書いていくと、あれもこれもと書いているうちに次第に内容が膨大になっていき、後で振り返りをしようと思ったらメモが読みづらいとか内容を追加しようと思ったらどこに何が書いてあるかわかりづらい…なんてこともあるかと思いま
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
sphinxcontrib-markdown
