2

RestructuredTextで書かれたドキュメントを提供するためにDjangoアプリを書いています。私は*.rstで書かれた多くの文書を持っています、それらのそれぞれは多くのセクション、サブセクションなどでかなり長いです。

ドキュメント全体を単一のページに表示することは、Djangoフィルターを使用しても問題ありませんが、最初のページにトピックインデックスだけを表示し、単一のセクション/サブセクションを表示できるURLにリンクします(これにはいくつかの必要があります) '前へ|上へ|ホーム|次へ'リンクだと思います...)。docbook/XMLからHTMLへの変換のような「複数のHTMLページ出力」と同様の方法で。

* .rstドキュメントのドキュメントツリーを構築し、その1つのセクションを解析する方向を誰かに教えてもらえますか、または同様の結果を取得するための賢い方法を提案できますか?

4

1 に答える 1

1

選択肢1.ドキュメントの他の部分へのURLリンクを含めます。

index.rst、part1.rst、part2.rstなどを記述します。index.rstには他の部分へのリンクがあります。これは、RST HTMLリンクが正しいことを確認するための慎重な計画を除いて、ほとんど作業を必要としません。

「解析」はありません。ドキュメントをセクションに分割するだけです。手動で。

[これは非常に明白なようです、私はそれについて言及することを恐れています。]

選択肢2.Sphinxを使用ます。これは、目次とドキュメント間の接続を非常にうまく管理します。

ただし、RSTへのSphinx拡張機能はDjangoによって直接処理されないため、Sphinx出力を保存してから、それをDjangoに表示する必要があります。Sphinxから出力されたJSONHTMLBuilder ( http://sphinx.pocoo.org/builders.html?highlight=json#sphinx.builders.html.JSONHTMLBuilder )を使用します。次に、これらのドキュメントをテンプレートを介してレンダリングします。

于 2010-08-24T16:00:22.523 に答える