Your SlideShare is downloading. ×
Sphinx cheatsheetjp v01
Upcoming SlideShare
Loading in...5
×

Thanks for flagging this SlideShare!

Oops! An error has occurred.

×

Introducing the official SlideShare app

Stunning, full-screen experience for iPhone and Android

Text the download link to your phone

Standard text messaging rates apply

Sphinx cheatsheetjp v01

2,138
views

Published on

http://dl.dropbox.com/u/3864210/SphinxCheatSheetJP_v01.pdf と同じもの。Sphinx使い始めて間もない方向けのチートシート。

http://dl.dropbox.com/u/3864210/SphinxCheatSheetJP_v01.pdf と同じもの。Sphinx使い始めて間もない方向けのチートシート。


0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total Views
2,138
On Slideshare
0
From Embeds
0
Number of Embeds
4
Actions
Shares
0
Downloads
25
Comments
0
Likes
0
Embeds 0
No embeds

Report content
Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
No notes for slide

Transcript

  • 1. ■ターゲットを指定して出力、”make ○○" Sphinx チートシート (Lv.1) Makefile または make.bat に「生成したいファイル形※Sphinx の設定が一通り済んだ人向けです。 式」がターゲット名として書き込まれていますので確認し A4 サイズの用紙に 2in1 または表裏印刷で。 ましょう。 (参考にしたサイト: http://www.sphinx-users.jp/) たとえば HTML を生成したい場合には”make html”です。 設定および実行 ■conf.py の変更■ドキュメントフォルダの準備 sphinx-quickstart を実行した後でも、設定の変更は可能適当な場所にフォルダを作成しましょう。日本語を含む です。conf.py を書き換えます。フォルダはエラーとなる可能性がありますので、半角英数字を基本としましょう。 項目名 何を記入するの?ターミナル(bash/cmd.exe)から sphinx-quickstart コマ html_title HTML 出力時のタイトルンドを実行すると、いくつか質問されるので、 html_short_title HTML 出力時の短いタイトル答えていきましょう。 html_logo HTML 出力時のヘッダーロゴ html_favicon HTML 出力時の favicon最初のうちははほとんどの設問にはそのまま[Enter]を押して、入力が必要な 3 つの項目にのみ答えてみましょう。 extensions Sphinx 拡張を設定 language 言語を指定(ex. "ja") 項目名 何を記入するの? html_theme HTML 出力時のテーマ。ビルトインとProject name: プロジェクト名 して用意されているのは以下。 "default"/"sphinxdoc" /"scrolls" /"agAuthor name(s): 著者名 ogo"/"traditional"/"nature"/"haiku"/Project version: プロジェクトのバージョン。”1.0"等 "pyramid"sphinx-quickstart を実行したフォルダが「ドキュメント ■コードハイライトディレクトリ」となり、”make html"などのコマンドを実行する場所となることを覚えておきましょう。 Sphinx のコードハイライトは pygments を使用しています。 対応する言語と指定子については以下を参考に。 フォルダ名 説明_build ビルドされたドキュメントの出力先です。HTML http://pygments.org/docs/lexers/ なら”_build/html" 静的ファイルを置きます。HTML な ■Sphinx 拡張・テーマを使ってみる_static ら”_build/html/_static"にコピーされます。 blockdiag などの図を書くことが出来る拡張や、_templates テンプレートを格納します sphinxjp.themes.impressjs のようなかっこいいプレゼconf.py sphinx-quickstart で回答した設定が書かれ ン資料が出来るテーマなどがあります。これらは Python ています。拡張やテンプレートの設定もここに のパッケージとして提供されており、 pypi(パイピーアイ) 記述します。 から入手できます。Makefile “make”コマンド実行時に使用されます。make.bat Win 環境用バッチファイル http://pypi.python.org/pypi
  • 2. .rst ファイルを追加する パラグラフ:■index.rst ファイルに rst ファイルを追加する 「連続した行を一文」として考えます。行の折り返しはす べてつながった形で出力されます。"foo.rst"を加えた場合には、index.rst の目次(toctree)に以下のように拡張子を除いたファイル名を記載します。 行の折り返しをそのままにしたい場合は”|"を先頭に 置きます(ラインブロック)。 変更前 変更後.. toctree:: .. toctree:: reST HTML(イメージ) :maxdepth: 2 :maxdepth: 2 折り返しを 折り返しを 無効に foo 無効に | 折り返しを 折り返しを | そのままに そのままになお、.rst ファイル保存時には”utf-8(BOM なし)"を指定して保存します。 リスト: マークアップ reST HTML(イメージ)■reST マークアップと Sphinx 独自拡張 * 箇条書きリスト • 箇条書きリスト - インデント • インデントSphinx のマークアップは"reStructuredText”マークアップ 1. 最初に 1. 最初にをもとに、Sphinx 独自の拡張が追加された形です。 2. 次に 2. 次に • はやわかり reStructuredText • reStructuredText Primer(Sphinx) インラインマークアップ: イタリック("*イタリック*")、強調”**強調**”などを使え■マークアップ基礎編 ますが、効果の入れ子は出来ません。reStructuredText の特徴は インデントレベルによる階層の 引用:構成と ディレクティブ、ロールにあります。半角スペースのありなし、改行がキモです。インデントの単位は「半角 reST HTML(イメージ)スペース 3 つ」と覚えるといいようです。 これは引用:: これは引用: あいうえおえおあおセクション: あいうえおえおあお reST HTML(イメージ) コメント:==========章タイトル 章タイトル reST HTML(イメージ)========== .. これはコメント節タイトル========== 節タイトル 他にも:項タイトル 項タイトル---------- ディレクティブやロールを覚えてみよう。