SPHINX_RENDER_TOOL¶

Kinkdoc文書を、Sphinx文書生成システムのためのreStructuredTextファイル群へとレンダリングする起動可能モジュール。

使い方

kink [Kink_options]... mod:kink/doc/render/sphinx/SPHINX_RENDER_TOOL [Mod_options] Dir <Json

コマンドは、標準入力からJSONデータを読み取って、SphinxのためのreStructuredTextファイル群へと変換し、ディレクトリDirの下に書き出す。

Mod_options

• --anchor-prefix {Prefix} : reSTファイルの中のアンカーの接頭辞としてPrefixを使う。デフォルトでは `kinkdoc-` が使われる。

• --help : ヘルプを出力して終了する。

生成されるファイル

コマンドは、出力先のディレクトリに次のファイルを書き出す。

• index.rst: 文書レベルの節のブロックと、toctreeディレクティブ。

• Other .rst files: 2つ目以下のレベルの節の内容。通常、ひとつの.rstファイルがひとつのモジュールに対応する。

例:

• index.rst

• kink-STR.rst : kink/STRモジュール

• kink-NUM.rst : kink/NUMモジュール

• kink-container-FLAT_SET.rst : kink/container/FLAT_SETモジュール

• ...

アンカー

3つ目のレベル以下の節のタイトルには、相互参照のためのアンカーがつけられる。例:

.. _kinkdoc-0123456789abcdef0123456789abcdef:

type finger\_tree
=================

A finger tree is an immutable data structure for O\(log N\)
concatenation and splitting\.

.. _kinkdoc-fedcba9876543210fedcba9876543210:

Ft\.size
--------

\`size\` returns the size of the finger tree\.

Sphinx文書の中のreSTファイルはこれらの節を、次のように :ref: ロールを使って参照できる:

.. someotherpage.rst

You can call :ref:`Ft.size <kinkdoc-fedcba9876543210fedcba9876543210>`
to get the size of the finger tree.

アンカーは、節のタイトルと、先祖のレベルの節のタイトルから生成される。

利用例

$ kink mod:kink/doc/DOC_PARSE_TOOL --title 'API reference' src >doc.json
...
$ kink mod:kink/doc/render/sphinx/SPHINX_RENDER_TOOL src/sphinx/api  <doc.json

6.49.1. SPHINX_RENDER_TOOL.main(Argv)¶

mainは、モジュールの起動関数である。