将XML内容添加到Sphinx生成的文档中

1 投票
1 回答
1181 浏览
提问于 2025-04-17 10:32

我遇到了一个问题。我想用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的内容。

任何帮助都非常感谢。

祝好,
博格丹

1 个回答

1

根据文档的内容,似乎 literalinclude 可能正是你需要的东西:

.. literalinclude:: functions.xml

撰写回答