Windows 10 で Sphinx を使う

Sphinx とは

• Python で作成されたオンラインドキュメント作成ツールです。

• マニュアルなどの記述に向いています。

• reStructuredText で記述したテキストファイルを HTML 形式に変換して公開します。

• LaTeX と組み合わせることで PDF 形式に変換も可能です。

検証環境

• Microsoft Windows 10 Pro Version 1909 (64-bit)

• Miniconda

• Sphinx 2.4.3 & Sphinx 3.0.1

Contents:

• Sphinx の動作環境を作る
  • Miniconda をインストールする
  • Sphinx をインストールする
  • テキストエディターをインストールする
• ドキュメントの作成手順
• 日本語対応にする（日本語拡張の導入）
  • 事象の詳細
  • 日本語拡張の導入手順
• 「テーマ」を変更する
  • 「テーマ」とは
  • 「テーマ」の変更方法
  • Sphinx Themes
• 文書の構造
  • Sphinx の文書ファイル
  • 見出し
  • 目次と見出し
  • ".rst" ファイルの階層化 : toctree ディレクティブ
  • ドキュメントの分割 : include ディレクティブ
• いろいろな表現
  • 文字の表現
  • ロール
  • イメージ : image ディレクティブ
  • リンク
  • サンプルコードの表示
  • テーブル（表） : table ディレクティブ
  • 警告ディレクティブ
  • その他の表現
• CSS (Cascading Style Sheets)
  • 定義
  • 実行結果
  • その他の表現
• 付録
  • Visual Studio Code の日本語化
• 改版履歴