将xml内容添加到sphinx生成的文档中

问题描述 投票:1回答:1

所以这是我的问题。我正在尝试使用sphinx为我的项目生成文档,并设法获得基本工作,例如添加模块和图像。所以基本的index.rst看起来像:

.. |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文档。

但是,我在项目的一部分中使用了一些xml定义的方法来调用一些matlab函数,并且我想使该内容也可用于sphinx,即使是纯文本或实际的xml。我似乎找不到解决方法。因此,基本上,我将需要能够例如在包中:pck1.pck2(如果我具有functions.xml),以便在该级别的目录中添加指向html的链接,该链接将显示该xml的内容。

任何帮助将不胜感激。

关于,博格丹

python include python-sphinx substitution
1个回答
1
投票

查看文档,看来literalinclude可能正是您想要的:

.. literalinclude:: functions.xml
© www.soinside.com 2019 - 2024. All rights reserved.