3

我正在生成 Sphinx 文档,并且理想情况下希望我的文档字符串在代码中尽可能具有可读性,因此我希望将reStructuredText保持在最低限度,同时尽可能多地直接从文档字符串生成我的 Sphinx 文档。

特别是,我希望能够在可能的情况下将 URL 保留在我的文档字符串之外,将它们放在不太干扰的地方,并在适当的情况下将链接文本格式化为代码。但目前尚不清楚如何做所有这些事情。例如,

Sadly, `git`_, though it works as a link, does not format `git` as code, 
while ``git``_ generates an error; and `git <http://git-scm.com>`_ 
again does not format `git` while ``git` <http://git-scm.com>`_ is 
again an error.
.. _`git`:  http://git-scm.com

是否有我可以使用的扩展、设置或其他标记,以便像这样紧凑的东西

`git`_

或类似的替代品

:git:

生成一个代码格式的链接?

4

0 回答 0