简体   繁体   English

将其他html文档集成到sphinx文档中

[英]Integrate other html documentation into sphinx docs

How do you include html docs generated by other tools such as nose, coverage, and pylint reports into Sphinx documentation. 如何将其他工具(如nose,coverage和pylint报告)生成的html文档包含在Sphinx文档中。 Should they go into the _static directory? 他们应该进入_static目录吗? and if so, how do you link to them? 如果是这样,你如何链接到他们?

I am trying to build a concise package of all of the code development tool documentation into a .pdf or html. 我正在尝试将所有代码开发工具文档的简洁包构建为.pdf或html。

I have a similar problem and I could solve it by doing the following. 我有类似的问题,我可以通过执行以下操作来解决它。 Note this is just for the HTML output. 请注意,这仅适用于HTML输出。

  1. Create an index.rst field with just the following: 使用以下内容创建index.rst字段:

====================== Javadoc of the API XXX ======================

As I am using the extension "sphinx.ext.autosectionlabel", this becomes a "level 1" section. 当我使用扩展名“sphinx.ext.autosectionlabel”时,这将成为“1级”部分。

  1. Modify the Make file so, once the HTML is generated, it replaces the index.html of the section "Javadoc of the API XXX" with the Javadoc of my API. 修改Make文件,这样,一旦生成HTML,它就会用我的API的Javadoc替换“API XXX的Javadoc”部分的index.html。

After this change, on the toctree I have a link to "Javadoc of the API XXX" and when you click it, you see the Javadoc. 在此更改之后,在toctree上,我有一个指向“API XXX的Javadoc”的链接,当您单击它时,您会看到Javadoc。

I know is not the proper way of doing it, but it is the only that I have come up with after many Google searches. 我知道这不是正确的做法,但它是我在许多Google搜索后提出的唯一方法。

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

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