在Sphinx中生成外部链接

问题描述 投票:0回答:3

我想链接到我的 Sphinx 文档中的某个 URL:

<a href="http://some.url">blah</a>

我在文档中找到了类似的内容:http://sphinx-doc.org/ext/extlinks.html - 但按照惯例,它而是用链接替换自定义语法。相反,我只想生成一个指向外部网络资源的链接。

hyperlink python-sphinx restructuredtext
3个回答
67
投票

请参阅 reStructuredText 文档。可以通过命名引用来完成:

Test hyperlink: SO_.
    
.. _SO: https://stackoverflow.com/

或与:

Test hyperlink: `Stack Overflow home <SO>`_.
    
.. _SO: https://stackoverflow.com/

或者使用嵌入的 URI:

Test hyperlink: `Stack Overflow home <https://stackoverflow.com/>`_.

3
投票

这非常令人沮丧,但我在 2023 年中期找到了解决方案。

Presently, the fashion something called `"work-stealing" <BL94_>`_.

然后...

.. _BL94: http://supertech.csail.mit.edu/papers/steal.pdf

注意两个下划线:一次在尖括号内,一次在结束重音符号之后。 (反引号,如果您比互联网还年轻。)这可以正确地将文本

"work-stealing"
链接到 PDF 文章。


0
投票

对伊恩答案的修改:

Presently, the fashion something called `"work-stealing" <BL94_>`__.
and later...

.. _BL94: http://supertech.csail.mit.edu/papers/steal.pdf

区别在于末尾应使用两个下划线,而不是一个。

这是因为根据规范,这些是完全等效的:

`blah <foo>`_     <- only one underscore!
`blah`_

.. blah: foo

因此,带有一个下划线的示例也会生成“工作窃取”目标,这可能不是我们想要的。

使用两个下划线将创建一个匿名引用,这不会导致单独的新目标。

© www.soinside.com 2019 - 2024. All rights reserved.