Почему замена |версия| не работает на сфинксе

Я новичок в использовании Sphinx для документирования своей работы. Я хочу добавить номер версии и релиз в свою документацию в формате PDF.

В файле conf.py определена переменная версии, которую мы можем использовать в файлах .rst, например:

|version|

Но это не работает для меня, я не знаю, делаю ли я что-то не так. Какие-либо предложения?


versioning substitution python-sphinx restructuredtext rst2pdf
person Juan Manuel    schedule 21.12.2016    source источник
comment
Как у вас работает rst2pdf? Чтобы rst2pdf распознал подстановку |version|, определенную Sphinx (или что-либо в conf.py), вы должны настроить все, как описано здесь: rst2pdf.ralsina.me/handbook.html#sphinx.   -  person mzjn    schedule 22.12.2016
comment
Для запуска rst2pdf используйте rst2pdf index2.rst -o index.pdf -s styles/ictc.style --custom-cover = cover/ictc.tmpl -e /home/jmandujano/public_html/test2/extensions/blank_toc.py -b 1   -  person Juan Manuel    schedule 22.12.2016
comment
Расширение rst2pdf.pdfbuilder, где его найти?   -  person Juan Manuel    schedule 22.12.2016
comment
Расширение является частью дистрибутива rst2pdf.   -  person mzjn    schedule 22.12.2016
comment
Я установил свой conf.py как в руководстве, но он все еще не работает, может быть, ошибка в установке?   -  person Juan Manuel    schedule 23.12.2016
comment
Вы заставили это работать?   -  person mzjn    schedule 10.01.2017

Ответы (1)


arrow_upward
0
arrow_downward

Чтобы использовать замену, вам нужно определить ее в файле в формате:

.. |Version| replace:: 1.0

Затем используйте его в тексте:

 "Latest version is |Version|"

Я обычно включаю все замены в один файл, который затем включается в каждый файл в проекте с директивой:

.. include:: substitutions-file-name
person Mark Hoeber    schedule 22.12.2016
comment
Замена |version| (строчная v) определена по умолчанию. Он не должен определяться пользователем. См. sphinx-doc.org/en/stable/markup/inline. .html#подстановки. - person mzjn; 22.12.2016
comment
@mzjn Я прочитал эту часть и вот как я ее использую, но почему-то она не работает, я проверяю файл conf.py и не нахожу ошибок. - person Juan Manuel; 22.12.2016
comment
@mzjn Я получаю эту ошибку: (ERROR/3) Неопределенная ссылка на замену: version. - person Juan Manuel; 22.12.2016
comment
Вероятно, это вызвано rstcheck, а не Sphinx. См. github.com/sphinx-doc/sphinx/issues/9045. - person xqt; 02.04.2021