Поддержка псевдонима сфинкса (замены?) - PullRequest
Новая
       6

Поддержка псевдонима сфинкса (замены?)

0 голосов
/ 29 января 2019

Я подумываю переместить мою документацию из Doxygen в Sphinx и ищу альтернативу псевдониму Doxygen.

В Doxygen у меня есть псевдоним, который заменяет сложную команду, например таблицу, на более читаемый формат, как этот (это только примеры, и у меня есть более сложные и вложенные): 

   table_row2{2}=<tr><td align= center>\1</td><td align= center>\2</td></tr>

или 

 limited_res{1}=The number of supported \1 depends on the specific platform. See the \ref appendixes section"

Это можно использовать в документации, подобной этой: 

...
table_h2{ Resource Name, Value }  
table_row2{ MAC Entries , 256}
table_row2{ Ingress Flow , \limited_res { Ingress Flow } }
...

Самая близкая вещь, которую я нашел в Сфинксе - это замены, но у меня есть проблемы с тем, чтобы заставить его работать даже дляподстановка простых команд, как показано ниже: 

.. |H1| replace:: `*****************************************************`

My section
|H1|

H1 либо не компилируется, либо просто печатает '* ... *'.

Я не уверен, является ли это проблемой синтаксиса или просто не может быть сделано.Я пытаюсь избежать запоминания того, что из * / + / - / = означает что, и называю его уровнем вложенности.Моя память не очень хорошая в наши дни :)

И более важная проблема: кажется, что замены не принимают параметры, которые я нашел существенными.

Еще один вариант, о котором я могу подумать, - это написать расширения вроде this , но я надеюсь на более простой метод.

Любая помощь / указатели будут высоко оценены.

Спасибо, Илья.

1 Ответ

0 голосов
/ 29 января 2019

Чтобы звездочки отображались под «Моим разделом», вам нужна хотя бы одна пустая строка, отделяющая «Мой раздел» от «| H1 |».Пробел в Sphinx / documenttils имеет значение, а разделенный контент интерпретируется как два абзаца вместо встроенного текста. 

.. |H1| replace:: `*****************************************************`

My section

|H1|

Чтобы отобразить обратные черты, экранируйте их с помощью символа обратной косой черты \. 

.. |H1| replace:: \`*****************************************************\`

My section

|H1|

Если вы хотите вставить raw, вы можете использовать директиву raw .

EDIT

Это создаетa section . 

My section
==========

Пустая строка между двумя абзацами создаст абзацы, как отмечено выше.

...