python - 狮身人面像 : link to an internal file declared as html_extra_path

标签 python javadoc python-sphinx

我目前正在为 API 构建文档。为此,我同时使用 Sphinx 文档和 Javadoc:Javadoc 来显示数据模型,解释序列化的类,Sphinx 来解释路由和一般概念。

我已将 javadoc 添加到 sphinx 项目中的/javadoc 子文件夹中,并在 conf.py 中将其声明为“html_extra_path”。目前,在构建之后,我可以在/build 文件夹中看到/javadoc 文件夹,并对其进行导航。

在我的 sphinx 文档中,我想创建一个指向 javadoc 页面的链接(直接链接到类文档)。

我怎样才能做到这一点?

最佳答案

使用 external link没有协议(protocol)和主机名。这个重构文本:

`Javadoc </javadoc>`_

...产生 HTML:

<a class="reference external" href="/javadoc">Javadoc</a>

关于python - 狮身人面像 : link to an internal file declared as html_extra_path,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/49967691/

相关文章:

python - 从 while 循环返回而不退出它 python

python - 通过聚合 RPC 调用来加速 GAE-Py 中的模板

java - 如何在我的文档中记录或排除生成的 BuildConfig 类?

android-sdk\docs\reference 丢失

templates - 如何向 Sphinx 文档添加自定义页脚?

github - Sphinx 文档语言、版本和下载链接

python - Apache Beam DirectRunner 与 "normal"并行进程

c++ - Boost.Python : Wrap functions to release the GIL

java - 选择性 API Javadoc

python - Sphinx 文档,带编号的图形引用