原稿を書いてみよう¶
それでは、原稿を書いてみましょう。
原稿を書くツール¶
その前に、原稿はテキストファイルに入力するのですが、Windowsのメモ帳は使えません。
文字コードをUTF8、改行コードをLFにしなければならないのですが、Windowsのメモ帳ではテキストファイルの文字コードや改行コードの指定が出来ないのです。
この際、テキストエディタを使ってみることをお薦めします。Mery、Terapad 、gPad、サクラエディタなど、UTF8に対応した無料で実用できるテキストエディタがあります。検索や置換の機能なども充実してて、便利ですよ。
原稿を書いてみる¶
それでは、原稿を書いてみましょう。
エクスプローラでdoc.rstという空のファイルを作って、テキストエディタで開きます。
doc.rst下記のように書いて、保存します。
はろーわーるど
==============
文字の下のイコールの部分にも意味がありますので、省かないでくださいね。
次に、index.rstをテキストエディタで開きます。
captionと書いてある行とIndicesと書いてある行の間に、doc.rstと書きます。doc.rstのdの文字が、captionと書いてある行の最初のコロン(:)と同じ並びになるようにしてください。Pythonでは、インデントでプログラムのブロックを表します。つまり、toctreeというブロックの中にdoc.rstが入りますよということです。
できあがったindex.rstはこのような感じになると思います。
.. trial documentation master file, created by
sphinx-quickstart on xxx xxx xx xx:xx:xx xxxx.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to trial's documentation!
=================================
.. toctree::
:maxdepth: 2
:caption: Contents:
doc.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
そうしたら保存して、テキストエディタを閉じてください。