2012-01-18 8 views
1

だから私の問題です。私はsphinxを使って私のプロジェクトのドキュメンテーションを生成しようとしており、モジュールやイメージの追加などの基本的な作業をすることができました。したがって、基本的なindex.rstは次のようになります。xmlの内容をスフィンクスに追加doc

.. |tvb| replace:: `The Project` 
.. _tvb: http://www.myproject.org 

.. |logo| image:: img/evil_tvb_logo_transparent.svg 
    :alt: The Project 
    :align: top 
    :height: 148 
    :target: tvb_ 


|logo| 
******* 
My Modules 
========================= 

.. toctree:: 
    :maxdepth: 6 

    tvb 

「tvb」には、トップレベルのモジュールとサブパッケージへのリンクなどが含まれています。これはうまくいくように見え、それに応じてHTMLドキュメントが生成されます。

しかし私はいくつかのMATLAB関数を呼び出すためにプロジェクトの一部で使用されるxml定義のメソッドをいくつか持っています。純粋なテキストまたは実際のものと同じであってもその内容をスフィンクスでも利用できますxml。私はこれを行う方法を見つけることができないようです。ですから、基本的には、たとえば、パッケージ内にpck1.pck2という機能を持たせる必要があります。たとえば、functions.xmlがある場合は、そのレベルのtocにそのxmlのコンテンツを表示するhtmlへのリンクを追加する必要があります。

ご協力いただければ幸いです。

よろしく、 ボグダン

答えて

1

のドキュメントを見てみると、それはそうですliteralincludeは、あなたが探しているものかもしれないことを:

.. literalinclude:: functions.xml 
関連する問題