Django - 使用admindocs自动生成自己代码的文档

Question

6

是否有一种方法可以使用 django.contrib.admindocs 包为我自己的模型、视图和在单独的 .py 文件中拥有的函数生成 HTML/PDF 文档？

- Siavash

太宽泛了？ :facepalm: - Csaba Toth

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Alvin · Accepted Answer

5

可能性取决于您的文件文档结构如何组织

如果您只是想从Python文件中生成用户友好的文档，则最好使用Python Sphinx

这几乎是生成HTML文档的标准方法 - 与ReadTheDocs上使用的系统相同

- Alvin

你能否将编译好的Sphinx HTML文档与Django管理界面连接起来，以便只有工作人员用户可以看到它们？ - littlepea

1

有几种方法，我首先想到的是将Sphinx文档复制到一个模板文件夹中，并创建一个自定义的URL/视图，将该目录映射到仅限工作人员的限制--然后在管理模板中添加一个链接到该部分--可能有更优雅的方法来完成这个任务，但这提供了一个起点。 - Alvin

1

谢谢Alvin！实际上，我已经为这个目的制作了一个可重用的应用程序：django-docs ;) - littlepea

如何将数据模式（例如admindocs中的模式）包含到Sphinx中？ - Csaba Toth