与链接脚注打印的PDF输出(Printable PDF output with links as f

2019-10-21 11:51发布

我使用的狮身人面像,生成一个Python项目的文档,我大量使用外部链接。 我想建立htmllatexpdf这些为可点击的链接(这是默认的)输出,也将被打印出来,与这些链接显示在脚注了一个PDF版本。

简而言之:有没有写在外部链接的方式.rst像这样的文件:

Ask a question on `my favorite Q&A website <http://stackoverflow.com/>`_.

并有特殊的输出,将其解释为,如果它是这样写的一个注脚:

Ask a question on my favorite Q&A website [#SO]_.

.. [#SO] http://stackoverflow.com/

同时保持其它输出正常行为(没有脚注点击链接)?

Answer 1:

Jongware的评论让我看看狮身人面像的文档,我没有看到的部分,我意识到其实是我想要做什么配置变量:

latex_show_urls = 'footnote'

正如我希望能够生成通常PDF和一个有脚注不改变conf.py文件,我离开的默认值,并增加了以下规则狮身人面像的Makefile:

.PHONY: printpdf
printpdf: SPHINXOPTS+=-Dlatex_show_urls=footnote
printpdf: latexpdf

该规则要求的常规latexpdf规则,加入-Dlatex_show_urls=footnote ,以提供给选项sphinx-build

有了这个,我们可以生成与PDF要打印(使用说明):

make printpdf

如果我们想要一个常规的PDF,没有潜在的纷繁(这里)没有用脚注,正规规则还是做的:

make latexpdf


文章来源: Printable PDF output with links as footnotes