タグ

PythonとSphinxに関するhigedのブックマーク (4)

  • ReStructuredText 入門

    以下の文章中に "(quickref)" という形式のリンクがあります。これは、 Quick reStructuredText ユーザリファレンスへの相対リンクです。このリンクが 切れている場合は、 オンラインのクイックリファレンス を参照してください。 構造 まずはじめに、"Structured Text" (構造化されたテキスト)という呼び方には、 いくぶん不適切なところがあると指摘しておきます。実際には、首尾一貫したパターンを使う "Relaxed Text" (形式ばらないテキスト)とでも呼ぶべきものです。そのパターンを HTML コンバータで変換することで、WEB ブラウザで扱えるような「非常に構造化された テキスト」が生成されるのです。 最も分かり易くて基的なパターンは、 パラグラフ(段落) (quickref) です。 (1つ以上の)空行で区分されたテキストのひとかたまりが

  • はやわかり reStructuredText

    マークアップ記法の完全な詳細は reStructuredText のページに示されています。このテキストは、覚書としての性格の文書です。 "(詳細)" というリンクを辿ると reStructuredText 仕様書を参照できます。 ただし、相対リンクとなっていますので、リンク切れの場合は、 原版の "Quick reStructuredText" から参照してください。 目次 インライン マークアップ バックスラッシュによるエスケープ 章立ての構造 段落 記号つきリスト 番号つきリスト 定義リスト フィールドリスト オプションリスト 整形済みブロック ラインブロック 引用 Doctestブロック 表 区切り線 明示的マークアップ 脚注 出典 リンクターゲット 外部ターゲット 内部ターゲット 間接ターゲット 暗黙ターゲット ディレクティブ 代入参照とその定義 コメント 助けを得たい場合は

  • Client Challenge

    higed
    higed 2017/03/30
    SphinxでMarkdownからTOCを自動生成するライブラリ。"#"がドキュメント名、"##"が章に対応する。source_parsersはcommonmarkを使っても動く。
  • 第1日目 Sphinx環境を構築しよう! — Sphinx Advent Calendar 2012 (全部俺)

    第1日目 Sphinx環境を構築しよう! 初日は私が普段Windows上でどのようにSphinx環境を構築しているかをご紹介します。 Pythonのインストール SphinxはPythonの拡張モジュールなので、まずPythonのインストールが必要です。 下記ページよりインストーラーをダウンロードします。 Windows用インストーラ python-2.7.3.msi http://www.python.jp/Zope/download/pythoncore ノート Windowsの64bit(x64)版の場合も、上記のバージョンをダウンロードして下さい。 パッケージ管理ツール easy_install のインストール Pythonの拡張モジュール easy_installコマンド をインストールします。 下記をダウンロードします。 http://python-distribute.org

  • 1