reStructuredText для SQL?

Question

Я пытаюсь использовать DocUtils и reStructuredText для комментирования кода SQL.Я могу заставить это работать, когда я включаю разметку в многострочные комментарии.Затем я использую --Some text ::, чтобы ввести каждый блок кода.

Я не могу заставить работать внутренние гиперссылки.Я хотел бы написать - .. Step1_: но парсер игнорирует это из-за ведущего комментария.Использование многострочного стиля также не удается.Есть ли способ заставить это работать?

Вот пример:

/*
==========
this query
==========
:Author: Me

Outline
==========

- Create table 1

- Create table 2

- Output the result

*/

-- _Step1: build the table::

    create table table1

-- _Step2: use Step1_ to build table 2::

    create table table2

Answer 1

Я использую Sphinx для реструктуризации текста. Синтаксис для внутренних гиперссылок будет, например,

.. step1:

.. code-block:: sql

   create table table1     

This is later text in which an internal hyperlink occurs. Note
the indention of <strong>create table table1</strong>. It is part
of the <strong>.. code-block:: sql</strong> directive, so it must be indented.
Now here comes the internal link. Please see :ref:`step1` as
to how to create the table.

Answer 2

code-block поддерживается docutils версия 0.10 или может быть 0.9.