Список полей сфинкса - форматирование разрыва строки URL - PullRequest
Новая
       37

Список полей сфинкса - форматирование разрыва строки URL

2 голосов
/ 27 апреля 2020

Я использую sphinx для генерации документации для проекта.

Я использую список полей, ссылаясь на длинный URL.

Мой скрипт reST ниже: 

**Operação**
^^^^^^^^^^^^

:Fonte: https://google.com.br
:Github: https://github.com/123456789876543221/hello_world/987654321/random/path/lalalalalalallaa/12345678987654321.py
:Tópicos adicionais: lorem ipsum.
:Pós-processamento: \-

Сгенерированный html:

enter image description here

Как разделить URL на две строки, чтобы не задушить левую столбец с категориями полей?

1 Ответ

2 голосов
/ 04 мая 2020

Вычисление CSS кажется правильным путем go. Но если вам нужно «быстрое исправление» с использованием только директив reST , наиболее практичным может показаться:

  1. Усечение URL . (Недостаток избирательного сокращения URL-адреса.)
  2. Использование стоимости Список таблиц . (Недостаток изменения формата списка полей.)

enter image description here

**Operacao**
^^^^^^^^^^^^

:Fonte: `a short url`_
:Github: alongurl_
:Tópicos: `https://www.a_very_long_url/..truncated../file.html`_ lorem ipsum.


.. _a short url: http://google.com
.. _alongurl: http://google.com/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
.. _https://www.a_very_long_url/..truncated../file.html: https://github.com/123456789876543221/hello_world/987654321/random/path/lalalalalalallaa/12345678987654321.py


.. list-table:: 
   :widths: 30

   * - :Fonte: alongurl_ 
   * - :Github: If we took the bones out, it wouldn't be crunchy, now would it?jjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjjj 
   * - :Tópicos: https://github.com/123456789876543221/hello_world/987654321/random/path/lalalalalalallaa/12345678987654321.py

Я думал о редактировании или замене ссылок на гиперссылки с использованием Определения подстановки , но, очевидно, reST не позволяет этого.

Вы можете определить HTML во внешнем файле и включить его или использовать Передача необработанных данных , но в этом конкретном случае c эти все еще кажутся низкими «обходными путями» для того, что по существу должно быть достигнуто с помощью CSS.

Кроме того, я подумал об использовании линейных блоков (или аналогичных) внутри таблицы списка как способ вручную разделить URL на строки. Но это похоже на выдвижение синтаксиса разметки reST за пределы его предполагаемого использования ...

Возможно, существует действительно разумный способ сделать это, если вы понимаете Иерархия элементов достаточно хорошо, но я бы упростил задачу, внеся изменения в конечный продукт с HTML по CSS вместо детальной настройки reST .

...