Функция форматирования смещения со сфинксом и темой - PullRequest
0 голосов
/ 29 марта 2020

Я использую тему scipy и sphinx с autodo c + autosummary. Когда я создаю свою документацию, я получаю область серого прямоугольника рядом с описанием параметра.

My Output

Вместо этого я хотел бы, чтобы он посмотрел пример, где они серого прямоугольника на слово, параметр.

Numpy Example

Есть идеи, где происходит эта настройка?

Я строю на Ubuntu 18 (через wsl2) и windows 10. То же самое происходит. С Sphinx 2.4.4

Для справки тема по умолчанию выглядит следующим образом:

default theme

1 Ответ

0 голосов
/ 04 апреля 2020

После еще одного тестирования я также обнаружил, что linux и windows давали мне разные (совсем немного) разные результаты, поэтому я начал сравнивать вывод html и обнаружил небольшую разницу:

<dl class="field-list"> против <dl class="field-list simple"> над разделом Параметры. Это привело меня к нескольким проблемам с github.

В конце ответ на вопрос состоит в том, что сфинкс 2 изменился на html5, исходя из этой проблемы: https://github.com/sphinx-doc/sphinx/issues/6472

Путем добавления html4_writer = True к файлу config.py форматирование работает.

enter image description here

...