epydoc 和 reStructuredText 更改链接名称

发布于 2024-09-15 11:06:54 字数 342 浏览 7 评论 0原文

我将 reStructuredText 与 epydoc 一起使用。如何使内部链接的文本与链接的目标不同?我有:

:todo: Figure out the `Product.manufacturer` relationship in `Product`.

产品链接看起来不错并且链接到产品对象。 Product.manufacturer 链接转到正确的成员变量,但我只想成为制造商,而不是 Product.manufacturer 文本。

我知道如果我使用 epytext 就可以做到这一点,但我们想坚持使用 reStructuredText,以便我们可以稍后根据需要切换文档生成器。

I'm using reStructuredText with epydoc. How can I have the text of an internal link different than the target of the link? I have:

:todo: Figure out the `Product.manufacturer` relationship in `Product`.

The Product link looks fine and links to the Product object. The Product.manufacturer link goes to the proper member variable, but instead of the text being Product.manufacturer, I'd like to just be manufacturer.

I know this can be done if I use epytext, but we'd like to stick with reStructuredText so that we can switch documentation generators later if we want to.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

嘴硬脾气大 2024-09-22 11:06:54

我自己对 epydoc 并不熟悉,但正常的 reStructuredText 方式是这样的:

`manufacturer <Product.manufacturer>`_

或者,使用 Sphinx,

:attribute:`manufacturer <Product.manufacturer>`

考虑到 epydoc 似乎已经覆盖了提供链接的默认角色,它将被留给它。然而,这是最有可能起作用的:

:todo: Figure out the `manufacturer <Product.manufacturer>` relationship in `Product`.

I'm not familiar with epydoc myself, but the normal reStructuredText way would be this:

`manufacturer <Product.manufacturer>`_

Or, with Sphinx,

:attribute:`manufacturer <Product.manufacturer>`

Considering that epydoc seems to have overridden the default role to provide links, it will be being left to it. However, this is the most likely to work:

:todo: Figure out the `manufacturer <Product.manufacturer>` relationship in `Product`.
~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文