 |
 |
 |
Python ドキュメントの作成 |  |
 |
|
|
|
Python ドキュメントの作成 | |
|
Python ソースコードや対話セッションの例は \verbatim 環境で 表現します。この環境は LATEX の標準です。TEX はタブをスペースに 変換せずに捨てるので、 コード例中でのインデントにはスペースだけを使用することが重要です。
対話セッションの表現には、プロンプトや Python コード由来の出力 を含める必要があります。対話セッションには特殊なマークアップを 行う必要はありません。最後の入力行または出力行を示した後に、 ``未使用の'' 一次プロンプトを置いてはなりません; 以下に やってはいけない 例を示します:
>>> 1 + 1 2 >>>
\verbatim 環境の中では、LATEX の特殊文字を何がしかの特殊な 方法でマークする必要はありません。例題は全体が等幅フォントで 表示されます; この環境は Python コードの表示でなくても、コードの 表示でさえなくても使えなければならないため、``整形印刷'' は一切 行おうとしません。\verbatim で表示する際には、先頭や末尾に 空行を入れてはなりません。
長い\verbatim テキストを表示する場合には、平文テキストだけの 入った例題のテキストを外部ファイルに入れて取り込めます。 ファイルは標準マクロ \verbatiminput で取り込めます; このマクロは単一の引数名として、例題テキストの入ったファイル名を とります。例えば、 example.py の入った Python ソースファイルを 取り込むには、以下のようにします:
\verbatiminput{example.py}
\verbatiminput を使うと、取り込むファイルに対して特殊な 編集モードを使いやすくできます。ファイルはドキュメントの LATEX ファイルと同じディレクトリに置かねばなりません。
Python Documentation Special Interest Group では、 コード表示や対話セッションに対して整形印刷を行うための数々の アプローチについて議論してきました; この話題に関する詳細は、 Python Web サイトの Doc-SIG エリアを参照してください。
|
|
|
Python ドキュメントの作成 | |
|