добавление XML-контента в документ, созданный sphinx - PullRequest
1 голос
/ 18 января 2012

Итак, вот моя проблема. Я пытаюсь сгенерировать документацию для своего проекта, используя 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 голос
/ 19 января 2012

Глядя на документацию, кажется, что literalinclude может быть тем, что вы ищете:

.. literalinclude:: functions.xml
...