Sphinx:链接到声明为html_extra_path的内部文件

时间:2018-04-22 15:36:33

标签: python javadoc python-sphinx

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

我已将我的javadoc添加到我的sphinx项目中的/ javadoc子文件夹中,并将其声明为" html_extra_path"在我的conf.py.目前在构建之后,我可以在我的/ build文件夹中看到/ javadoc文件夹,浏览它。

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

我该怎么做?

1 个答案:

答案 0 :(得分:0)

使用没有协议和主机名的external link。这个reStructuredText:

`Javadoc </javadoc>`_

...产生HTML:

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