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

时间:2022-05-26 16:16:02

Is thre a way to use the django.contrib.admindocs package to generate HTML/PDF documentation for my own models and views and functions I have in seporate .py files

是一种使用django.contrib.admindocs包为我自己的模型生成HTML / PDF文档的方法以及我在seporate .py文件中的视图和函数

1 个解决方案

#1


4  

possible -- depends on how the docs for your files are structured

可能 - 取决于文件的文档结构

If you're just looking to generate user friendly docs from your python files you may be better off with Python Sphinx http://sphinx.pocoo.org/

如果您只是想从python文件生成用户友好的文档,那么使用Python Sphinx可能会更好http://sphinx.pocoo.org/

pretty much the standard for generating HTML documentation -- same system used on ReadTheDocs

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

#1


4  

possible -- depends on how the docs for your files are structured

可能 - 取决于文件的文档结构

If you're just looking to generate user friendly docs from your python files you may be better off with Python Sphinx http://sphinx.pocoo.org/

如果您只是想从python文件生成用户友好的文档,那么使用Python Sphinx可能会更好http://sphinx.pocoo.org/

pretty much the standard for generating HTML documentation -- same system used on ReadTheDocs

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