Windows 10 で Sphinx を使う
latest
Contents:
Sphinx の動作環境を作る
Miniconda をインストールする
Sphinx をインストールする
テキストエディターをインストールする
ドキュメントの作成手順
日本語対応にする(日本語拡張の導入)
事象の詳細
日本語拡張の導入手順
「テーマ」を変更する
「テーマ」とは
alabaster ← デフォルトのテーマ
classic
sphinxdoc
scrolls
agogo
traditional
nature
haiku
pyramid
bizstyle
「テーマ」の変更方法
Sphinx Themes
導入手順
文書の構造
Sphinx の文書ファイル
見出し
見出しの構成
見出しの例
目次と見出し
".rst" ファイルの階層化 : toctree ディレクティブ
ドキュメントの分割
toctree ディレクティブ
下位階層の "rst" ファイルを下位フォルダーに配置した場合
toctree ディレクティブのオプション
ドキュメントの分割 : include ディレクティブ
いろいろな表現
文字の表現
強調(イタリック)
強い強調(太字)
コードサンプル
フィールドリスト
"\" の表記
ラインブロック
リスト(箇条書き)
リテラルコードブロック
ロール
ボタンなど : guilabel
コマンド : command
言葉の短縮形 : abbr
ファイルやディレクトリ : file
ファイルのダウロード : download
メニューの遷移 : menuselection
キーボード : kbd
数式 : math
イメージ : image ディレクティブ
リンク
URL
rst ファイル
ラベル
サンプルコードの表示
コードブロック : code-block ディレクティブ
ファイルから表示するコードの読み込み : literalinclude ディレクティブ
コード表示のオプション
テーブル(表) : table ディレクティブ
グリッドテーブル
シンプルテーブル
CSV テーブル
リストテーブル
複雑なテーブル
列幅の変更
ヘッダーの指定
テーブル名の追加
警告ディレクティブ
attention
caution
danger
error
hint
important
note
tip
warning
admonition
その他の表現
横線
CSS (Cascading Style Sheets)
定義
準備
ファイルの配置
conf.py ファイル
実行結果
その他の表現
テーブルのセル内の折り返し
付録
Visual Studio Code の日本語化
改版履歴
Windows 10 で Sphinx を使う
»
いろいろな表現
Edit on GitHub
いろいろな表現
¶
文字の表現
ロール
イメージ : image ディレクティブ
リンク
サンプルコードの表示
テーブル(表) : table ディレクティブ
警告ディレクティブ
その他の表現
Read the Docs
v: latest
Versions
latest
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds