study sphinx
  • 1. Sphinxとは
    • 1.1. Sphinxのよくある利用例
    • 1.2. Sphinxの処理の流れ
  • 2. Sphinxのインストール
    • 2.1. 事前準備
    • 2.2. インストール
    • 2.3. うまくいかない時用
    • 2.4. Sphinxの動作確認
  • 3. ハンズオン:勉強会レポートを作成しよう
    • 3.1. 書く項目を決めます
    • 3.2. Sphinxプロジェクトを作りましょう
    • 3.3. まずはタイトル
    • 3.4. 続いて、各セクションを作成します。
    • 3.5. 参加者と日時
    • 3.6. 勉強会の内容 段落、引用文
    • 3.7. リスト、サブリスト
    • 3.8. 強調
    • 3.9. 資料 リンク
    • 3.10. ひとくぎり
    • 3.11. 複数のファイルを扱う。
    • 3.12. ファイルをリネームする。
    • 3.13. ディレクトリを作成する。
    • 3.14. index.rstを作成
    • 3.15. できたらビルドです
  • 4. Sphinxでの文章の書き方(reStructuredText)
    • 4.1. セクション
    • 4.2. セクション(レベル2)
    • 4.3. レベル3
    • 4.4. 強調
    • 4.5. 引用
    • 4.6. 番号なしリスト
    • 4.7. 番号付きリスト
    • 4.8. コードブロック
    • 4.9. ラベルと参照
    • 4.10. 他のドキュメントへの参照
    • 4.11. リンク
    • 4.12. ダウンロード用のリンク
    • 4.13. 画像
    • 4.14. テーブル
    • 4.15. 注釈
    • 4.16. 索引
    • 4.17. 他のファイルのインクルード
    • 4.18. 参考
  • 5. 色々な変換
    • 5.1. epub
    • 5.2. pdf
    • 5.3. docx
  • 6. 色々なテーマ、sphinx拡張
    • 6.1. テーマ
    • 6.2. sphinx拡張
  • 7. 自分で拡張する
  • 8. その他
    • 8.1. markdownを使いたい人には
 
study sphinx
  • Docs »
  • sphinx handson
  • Edit on GitHub

sphinx handson¶

最初に

内容¶

  • 1. Sphinxとは
  • 2. Sphinxのインストール
  • 3. ハンズオン:勉強会レポートを作成しよう
  • 4. Sphinxでの文章の書き方(reStructuredText)
  • 5. 色々な変換
  • 6. 色々なテーマ、sphinx拡張
  • 7. 自分で拡張する
  • 8. その他

Sphinx について¶

  • Sphinx 日本語ドキュメント
  • ブロック図生成ツール blockdiag — blockdiag 1.0 documentation
Next

© Copyright Daisuke Igarashi.

Sphinx theme provided by Read the Docs