Blog

Sphinxで充実ドキュメントライフを!

Sphinxとは?

Python製のドキュメント作成特化型ライブラリ

Sphinxの特徴

  • マイナー言語、Tex(数式)に対応
  • ハイライト, 検索など便利機能
  • PDF, ePubなど出力可能
  • Pythonを知らなくても大丈夫!
  • もちろんPythonが使えれば自分用に拡張カスタマイズ可能!
  • Markdown記述
  • 無料

Sphinxをインストールしてみる

Pythonがインストールされているのを前提とします。
今回はLinux上での構築例。

pipをインストール

sphinxをインストール

Sphinxのプロジェクトを生成してみる

これでプロジェクトが自動生成されました。
source : 出力するための元となるコード
build : 出力されるhtml群などがここに入る

ではビルドしてみましょう。

これだけです。
/var/www/html/{{ プロジェクト名 }}/build/ をApacheでルートに設定して再起動!

こんな感じの初期表示がされます。
スクリーンショット 2015-12-24 17.07.01

HTMLのような面倒なタグ入力も要らずにコードや見出しも記述出来ます。

今回は時間がなかったためインストール手順までの内容となりました。

Author Profile

ohba
ランニングと音楽とヲタトーク好きプログラマーです。 数学と英語を勉強中です。 DeepLearning始めました!
» 投稿一覧
  • Launch Cart次世代ECサイト構築システム 初期月額無料
  • LaunchMovie ECに特化した動画制作サービス

Archive

ページTOPへ