问题标签 [cargo-doc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
2 回答
265 浏览

rust - 有没有办法在文档注释中内联一个常量(由货物文档呈现)?

使用“默认”构造函数,记录什么是……默认值是很有用的。如果这是在文档中以文本方式定义并单独定义为文字或静态/常量,则两者可能会不同步:

可以将文字提取到 const 或 static 并链接到它,但是读者必须通过间接了解该值是什么,并且 const / static 必须是pubcargo doc抱怨并拒绝链接到它。

有什么方法可以替换文档字符串中的 const 值而不是链接到它?或者其他一些可以避免间接的方法?又名

应呈现为:

创建一个a为 5的Foo 。bar

虽然类似,但如何将 Rust 宏变量嵌入到文档中?似乎不适用于这里。[doc]当给定名称作为参数(甚至是 const str)时抱怨意外的标记,我不知道包装宏是否可以强制替换 const。

0 投票
1 回答
185 浏览

rust - 生成 rustdoc 时如何使用本地文件作为 crate 徽标?

可以使用以下命令为 crate 设置favicon和rustdoc的徽标:

  • #![doc(html_favicon_url = "<url_to>/favicon.ico")]
  • #![doc(html_logo_url = "<url_to>/logo.png")]

如此处所述

但是,我不想公开上传我的徽标,因此希望自动将这些文件包含在/target/doc其中并从那里引用它们。

目前,我已将各自的数据 url(base64 编码)放入这些字段中,它工作正常,但它极大地膨胀了设置这些属性的源文件。

我知道我可以在target/doc使用脚本生成文档后将图像复制到其中,然后使用相对 url 引用它们,但我想避免这种情况,这样我仍然可以使用cargo doc.

编辑

评论中关于设置using--output标志的建议也没有奏效,因为它导致. 除此之外,它不适合我,因为(至少据我所知)我只能在那里给出绝对路径,而我需要使用图像的相对路径的解决方案,因为我将这些图像存储在cargo 根目录的子目录,以便使用 git 等轻松转移到另一个系统。rustdocrustdocflags.cargo/config.tomlerror: Option 'output' given more than once