Изображение и оглавление рядом в реструктурированном тексте с python-Shinx

Я использую 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`

Заранее спасибо.


image python-sphinx toctree restructuredtext
person Micawber    schedule 13.04.2018    source источник

Ответы (2)


arrow_upward
3
arrow_downward

Да, это возможно. Поместите директиву image перед директивой toctree. Затем используйте общий параметр, например:

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

Таблица стилей Sphinx по умолчанию, basic.css, может уже существовать в вашей теме, и в ней уже настроен стиль для перемещения изображения вправо. Если нет, то замените CSS вашей темы локальным файлом CSS или добавьте новый файл CSS в свою тему, в котором вы определяете новый стиль.

img.align-right {float: right;}
person Steve Piercy    schedule 13.04.2018

arrow_upward
2
arrow_downward

Другой вариант — использовать директиву 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                 |
   +--------------------------------------+--------------------------+
person asrjarratt    schedule 11.01.2019