将API文档显示为IPython笔记本

我们有一个Python项目，我们的文档目前分布在三个地方：我们有示例Python文件，我们有Sphinx文档（其中一些是由IPython笔记本生成的），我们有IPython笔记本。我们正在考虑将所有这些文档整合到一套IPython笔记本中。最终，我们希望通过将所有文档移动到一个地方，并使用一个工具（IPython笔记本），让用户和开发人员的生活更加轻松。而且，老实说，最大限度地减少文档维护所需的时间是这里的重中之重：所有开发人员都在业余时间免费工作

---

与IPython笔记本电脑相比，Sphinx的一大优势是，Sphinx可以使用apidoc从代码中自动生成API文档。我的直觉是，应该可以通过编写一些代码在IPython笔记本中复制这种行为，这些代码遍历库的python文件，提取文档字符串以显示在笔记本中（包括渲染任何数学或图像以及文档字符串的相关部分（参数、返回值、注释等））。我的问题是：这样的工具是否已经存在？i、 e.一个可以浏览Python目录、提取文档字符串并将其显示在IPython笔记本中的工具，理想情况下使用漂亮的HTML格式？

以下是两个您可能会发现有用的链接：

• ：这允许您在降价文档上使用IPython笔记本前端。还有一个mdipynb转换CLI工具。与文档生成工具中的ipynb文件相比，处理降价文档更容易

• ：我编写的一个快速脚本，用于从Python项目生成标记为的API文档。此处不涉及笔记本，但您可以使用ipymd将其转换为笔记本，或在笔记本前端对其进行编辑

---

非常有用，谢谢。ipymd看起来很有用，但图像的丢失可能会破坏我们的交易（我们的许多文档中都有绘图）。还是我误解了？您在Markdown中生成API文档的快速脚本看起来非常有趣，谢谢。（我应该提到的是，我有一些神经科学的朋友使用并喜欢klustakwik:）支持图像在待办事项列表中，应该相对简单：只需从ipynb中提取base64编码图像，保存到文件中，然后插入标记。您还可以将图像嵌入Markdown中的

HTML标记中。拉请求（欢迎…：）