我一直在使用Sphinx对我的代码做一个很好的文档,我想知道是否可以在目录旁边放置一个图像(而不是没有任何东西的大空白区域)
目前,我的初学者的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`
提前致谢。
答案 0 :(得分:2)
是的,这是可能的。将image
指令放在toctree
指令之前。然后使用common option,如下所示:
.. image:: _static/my_image.png
:class: align-right
Sphinx默认样式表basic.css
可能已存在于您的主题中,并且已设置样式以将图像浮动到右侧。如果没有,则使用本地CSS文件覆盖主题的CSS,或者在主题中添加新的CSS文件,在其中定义新样式。
img.align-right {float: right;}
答案 1 :(得分:1)
另一个选择是使用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 |
+--------------------------------------+--------------------------+