Sphinx удаляет форматирование кода из пользовательской ссылки на код
У меня есть следующие классы:
class A:
def x():
""" Do the thing. """
class B(A):
def x():
"""
Do the thing, but better than the :py:meth:`parent <A.x>`
"""
Весь модуль autodoc
редактор Я хотел бы иметь ссылку на родительскую реализацию x
который отображается как "родитель", а не как "parent
Msgstr "Как удалить форматирование кода из ссылки на пользовательский метод?
Сама ссылка интерпретируется правильно, основываясь на первом правиле форматов перекрестных ссылок.
Вот сгенерированный HTML-код для ссылки:
<a class="reference internal" href="#my_module.A.x" title="my_module.A.x">
<code class="xref py py-meth docutils literal">
<span class="pre">parent</span>
</code>
</a>
[Разрывы строк вставлены мной для разборчивости. Оригинальный HTML не имеет разрывов или пробелов между тегами.]
Я использую Sphinx 1.6.3 с Python 3.6.2 в среде Anaconda.
Обратный вопрос здесь: Sphinx добавляет форматирование кода к: ref:
1 ответ
Я сталкиваюсь с той же проблемой. Единственное решение, которое я нашел, это написать:
"""
Do the thing, but better than the `parent <#my_module.A.x>`_
"""
который создает обычную гиперссылку на A.x
запись на сгенерированной HTML-странице. Однако это работает только для вывода HTML; другие форматы (например, LaTeX) будут иметь неработающие ссылки.