我正在生成Sphinx文档,理想情况下我的文档字符串应尽可能在代码中可读,因此我希望将reStructuredText保持在最低限度,同时生成尽可能多的Sphinx文档。可以直接来自docstrings。
特别是我希望能够尽可能地保留我的文档字符串中的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:
生成代码格式的链接?