Sphinx の使い方
無料で読める本
Python 製ドキュメントツールである Sphinx の入門書です。 Windows 11 の操作練習を兼ねて評価版 Windows 11 上に環境を構築しました。Windows 10 上でも同じ手順で対応できると思います。 最初に Sphinx で文書を作成し、 GitHub Pages で公開するまでの手順を説明します。その後、Sphinx の各機能を説明します。 本書が Sphinx の使用をご検討されてている方が一歩踏み出す一助になれば幸いです。
Chapters
はじめに
Sphinx
環境構築 #1:Miniconda
環境構築 #2:Sphinx
環境構築 #3:VS Code
環境構築 #4:GitHub
VS Code と GitHub の関連付け
ドキュメント作成から GitHub Pages で公開までの流れ
ドキュメントのページ構成
見出しと toctree ディレクティブ
他のドキュメントを読み込む
文字の表現
リスト(箇条書き)
ロール
画像
リンク
テーブル(表)
コード
その他の表現
警告ディレクティブ
CSS (Cascading Style Sheets)
ビルトインテーマ
テーマを追加
conf.py ファイル
VS Code のターミナル
マークダウン
Change Log
Community
Author
Topics