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 create table table1. It is part 
of the .. code-block:: sql 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.