реструктурированный текст оглавления подгруппы - PullRequest
Новая
       26

реструктурированный текст оглавления подгруппы

0 голосов
/ 11 февраля 2019

Я пытаюсь получить оглавление с подгруппами, указывающими на разные первые файлы.Это мой index.rst: 

.. bonobo-trans documentation master file, created by
   sphinx-quickstart on Fri Feb  8 18:09:07 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. toctree::
   :maxdepth: 2

Transformations
---------------

- :doc:`source/source`
- :doc:`source/target`
- :doc:`source/lookup`
- :doc:`source/sequencer`
- :doc:`source/sorter`
- :doc:`source/aggregator`

Source
``````
Target
``````
Lookup
``````

Requirements
------------
- bonobo 0.6.3
- pandas
- sqlalchemy

Installation
------------

Install bonobo-trans by running:

    pip install bonobo-trans

Contribute
----------

- Issue Tracker: github.com/$project/$project/issues
- Source Code: github.com/$project/$project

Support
-------

If you are having issues, please let me know.

License
-------

The project is licensed under the Apache license.

Я добавил три подзаголовка, чтобы проиллюстрировать, как он должен выглядеть, но мне нужен только список ссылок в разделе «Преобразование».По сути, так должно получиться:

example

Возможно ли это?

1 Ответ

0 голосов
/ 18 февраля 2019

Эта опция, которая должна приблизить вас, заключается в использовании опции :hidden: для toctree.Однако вы не получите свернутый раздел или ссылки на заголовок на той же странице. 

Transformations
---------------

.. toctree::
   :maxdepth: 1
   :includehidden:

   sequencer
   sorter
   aggregator

.. toctree::
   :hidden:

   source
   target
   lookup

Requirements
------------
- bonobo 0.6.3
- pandas
- sqlalchemy

Installation
------------
...

Также обратите внимание, что на файлы просто ссылаются по их именам в оглавлении, что исключает необходимость использования :doc:.Также предполагается, что все ссылки на документы содержатся в каталоге source, при условии, что он настроен в conf.py.

...