問題タブ [docutils]

Sphinx ドキュメント ユーティリティの簡単な拡張機能があります (使用しているバージョンは Sphinx-1.1.3-py2.6 です)。Doug Hellmann によるこの優れた例と非常によく似ています。最終的な HTML にrel='bar'属性を追加するにはどうすればよいですか?鬼ごっこ？

これを行うにはいくつかの方法があるようですが、簡単な方法が見つかりませんでした。アドバイスやヒントをいただければ幸いです。

参照ノードは次の方法で作成されます。

ただし、rel='bar'属性は、最終的な HTML マークアップから取り除かれます。ソースを調べてみると、 sphinx/writers/html.pyとHTMLTranslatorクラスにたどり着きました。以下は、visit_reference メソッドの一部です。

追加の属性は処理されません。もしかしたら、他のパーツに交換できるかもしれません。その点で有用なものは見つかりませんでした。

だから、私はできる：

• 参照ノードのすべての機能を再実装するカスタム ノードを作成します。小さな追加のためのかなりの作業。
• sphinx/writers/html.pyの *visit_reference* メソッドを上書きします。より高速ですが、将来の Sphinx の更新に関しては悪いです。
• 事後 link タグに jQuery で rel 属性を追加します。まあ、きれいでもない。

明白でエレガントな解決策が欠けていると確信しています。

ありがとう！

テーブル内に目次を生成できるようにしたい。たとえば、境界線があり、次のようになります。

次のようなものからテーブルを自動生成したい:

出力は、html と pdf の両方です。

これはできますか？または、docutils パーサーなどを使用する必要がありますか?

サーバーが実行しているdocutilsのバージョンを検索していることに気づきました。驚いたことに、フラグ「--version」を指定してコマンドを入力するほど簡単ではありませんでした。ようやく以下のコマンドでわかりましたが、それ以上に直接的なものではないでしょうか。

rst2htmldocutils に付属のツールを使用して reST から HTML を作成しています。コードはすでにid個々のセクションに属性を割り当てているようです。これは、URL のフラグメント識別子として、つまりページの特定の部分にジャンプするためのアンカーとして使用できます。これらのid値は、セクションの見出しのテキストに基づいています。その見出しの文言を変更すると、識別子も変更され、古い URL が無効になります。

リンクを無効にすることなく見出しを編集できるように、特定のセクションの識別子として使用する名前を指定する方法はありますか? 自分のスクリプトから自分で docutils パブリッシャーを呼び出す方法はありますか?

docutil.nodesツリー用のreSTライターはありますか？見つかりませんでしたが、明らかなものが見つからない可能性があります。それとも自分で書くのは簡単ですか？reSTからreSTへの変換を実装したいと思います。

Djangoテンプレートのrestructuredtextフィルターを使用して、テンプレートの最初のファイルを表示しています。docutilsインストールして、に追加しdjango.contrib.markupましたsettings.py。最初のテキストの表示は正常に機能します。

ここで、最初のファイルに数学を追加したいと思います。

test.rst：

更新::これを部分的に修正しました。当初、エラーはでしたUnknown directive。テンプレートに数学ディレクティブを追加しようとしましたが、docutils0.10がデフォルトで数学ディレクティブをサポートしていることに気付きました。したがって、docutils-0.10にアップグレードしただけです。

しかし、今私が見ているのは次のとおりです。

最初のファイルrst2htmlは、ブラウザで確認すれば正常に機能します。違いは、htmlファイルはMathJax javascriptをロードしますが、Djangoテンプレートはjsファイルを追加しないことです。

だから私はいくつかの設定または構成が欠落していると推測しています...

ここで助けてくれて本当にありがたいです！

私はSphinxを使用していますが、本当に気に入っていますが、モジュールの概要がわかりません。エラーなどはありません。単純な...何もありません。これは私が自動文書化しようとしているモジュールです：

これは、ReSTインデックスファイルのSphinxディレクティブです。

私はスフィンクスから他のあらゆる種類の素晴らしいものを手に入れているので、それは私にとって一般的に壊れていません。私が得る唯一の疑わしいことは：SEVERE: Duplicate ID: "module-CONF"。いくつかのグーグルは、このエラーは非常に「正常」であると私に信じさせましたか？

次のように、Python モジュールで変数を文書化したとします。

モジュール文字列をドラッグしてドキュメント出力を生成することなく、.rst ファイルにその単一変数の autodoc を含めることはできますか?__doc__

私が試してみました

ただし、両方とも__doc__文字列をドラッグし、 の autodocs を表示しませんsome_random_name。

含まれるセクションが異なるドキュメントの複数のバージョンを作成したいと考えています。これを実現するには、通常、onlyディレクティブまたはifconfig拡張機能を使用します。ただし、toctreeディレクティブと組み合わせて使用​​することはできません。

私が基本的に欲しいのは次のようなものです：

それを行う方法はありますか？