Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Django - Use admindocs to Auto-Generate Documentation for Own Code [closed]

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

like image 679
Siavash Avatar asked Jun 13 '11 07:06

Siavash


People also ask

Why we create superuser in Django?

Creating a superuserIn order to view and create records we also need this user to have permissions to manage all our objects. You can create a "superuser" account that has full access to the site and all needed permissions using manage.py.


1 Answers

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

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

like image 117
Alvin Avatar answered Oct 31 '22 06:10

Alvin