图像和 table 内容在重组文本中与 python-Shinx 并排

Question

我一直在使用 Sphinx 为我的代码制作一个很好的文档，我想知道是否可以在内容的 table 旁边放置一个图像（而不是一个大的白色 space 没有任何东西）

目前，我初学者的 index.rst 文件如下所示：

.. XXXXXX documentation master file, created by
   sphinx-quickstart on Wed Apr 11 13:59:42 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to XXXXXX's documentation!
==================================

.. topic:: the_topic

   .. todo:: write topic

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   Tool1
   Tool2
   Tool3
   Tool4
   Tool5
   Tool6
   Tool7
   Tool8   

.. image:: _static/my_image.png
   :align: center


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

提前致谢。

Answer 1

是的，这是可能的。将 image 指令放在 toctree 指令之前。然后使用 common option，像这样：

.. image:: _static/my_image.png
    :class: align-right

Sphinx 默认样式 sheet、basic.css 可能已经存在于您的主题中，并且已经设置了一种样式以将图像浮动到右侧。如果没有，则用本地 CSS 文件覆盖主题的 CSS，或者将新的 CSS 文件添加到主题中，在其中定义新样式。

img.align-right {float: right;}

Answer 2

另一种选择是使用 table 指令。有关所有 table 指令选项，请参阅 http://docutils.sourceforge.net/docs/ref/rst/directives.html#table。

.. table::
   :align: center
   :widths: auto

   +--------------------------------------+--------------------------+
   | .. image:: _static/my_image.png      | .. toctree::             |
   |                                      |    :maxdepth: 2          |
   |                                      |    :caption: Contents:   |
   |                                      |                          |
   |                                      |    Tool1                 |
   |                                      |    Tool2                 |
   |                                      |    Tool3                 |
   |                                      |    Tool4                 |
   |                                      |    Tool5                 |
   |                                      |    Tool6                 |
   |                                      |    Tool7                 |
   |                                      |    Tool8                 |
   +--------------------------------------+--------------------------+

图像和 table 内容在重组文本中与 python-Shinx 并排

Image and table of contents side by side in Restructured Text with python-Shinx

image

python-sphinx

restructuredtext

toctree