繁体   English   中英

是否可以使用狮身人面像通过:class:角色链接到特定URL?

[英]Is it possible using sphinx to link to a specific URL using the :class: role?

我正在使用Sphinx记录一个Python程序包,该程序包包装了一个专有的API,据我所知,该API没有使用Sphinx记录。 API文档提供了有用的信息,但是URL的格式不是sphinx可以自动为其生成链接的格式。 在手动指定链接目标的同时,是否可以在语义上将字符串标记为类?

我试过了:

:class:`Class <https://api.documentation/some/path/to_class_constructor.htm>`_

但这会引起WARNING: Mismatch: both interpreted text role prefix and reference suffix. 然后我也尝试了

:class:`Class <https://api.documentation/some/path/to_class_constructor.htm>`

这不会发出警告,但也不会生成超链接。

根据Steve Piercy在下面的评论, sphinx.ext.extlinks扩展使文档更加sphinx.ext.extlinks ,但是却失去了语义上的含义,我希望保留它。

是否有可能以某种方式显示引用了类的文本,并同时链接到外部API文档?

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM