Ссылка на уравнение в другом файле с помощью Sphinx

Question

Я документирую свой код, используя Shinx .В некоторых файлах у меня есть математические формулы, и я хотел бы включить ссылку на них.Находясь в том же файле, это не проблема.Использование :eq:'reference'.

Однако, как вы перекрестно ссылаетесь на формулу из другого файла?В моем случае Sphinx не может найти ссылку.

Answer 1

Согласно документам Сфинкса здесь , перекрестные ссылки на уравнения в настоящее время работают только в одном и том же документе. Я предлагаю отправить запрос об ошибке / функции, чтобы это изменилось (при условии, что его еще нет).

В качестве обходного пути вы, вероятно, можете использовать универсальный синтаксис перекрестных ссылок , поместив метку ссылки непосредственно перед уравнением, на которое вы хотите сослаться (в «другом» файле), например так:

.. _equation_in_other_file:

, а затем используйте что-то вроде:

:ref:` Link Title <equation_in_other_file>`

в «текущем» файле для ссылки на него.

(обратите внимание, вам необходимо указать явный заголовок ссылки)

Это не так элегантно, но оно должно выполнить работу.