Documentando código Django
Una buena práctica

Cuando estamos desarrollando un sistema independientemente del lenguaje que sea, siempre es una buena decisión documentar el código fuente. Hay varias razones para apegarnos a esta práctica las cuales no voy a entrar en detalles porque nuestro objetivo es mostrarte en este breve articulo como puedes documentar tu codigo fuente hecho en django. Para el siguiente material de apoyo vamos a recomendar usar python3 y que tienes un entrono virtual con todas las librerias que usas en tu proyecto de django puesto que es el entorno donde se verifico este material.

Paso 1: instalar en tu en tu entorno virtual "docutils" con el siguiente comando pip install docutils

Paso 2: En settings.py , en la lista INSTALLED_APPS agrega django.contrib.admindocs

Paso 3: En el archivo urls.py agrega path('admin/doc/', include('django.contrib.admindocs.urls')) a la lista urlpatterns . Asegúrate de agregarla antes de admin/

NOTA: Para mejorar la informacion que refleja esta ayuda puedes agregar docstrings a tus métodos y cadenas alternas legibles y texto de ayuda a los campos de tu modelo. Ademas puedes probar agregando o eliminando comentarios entrecomillados al inicio de tus métodos y agregando un atributo help_text a las definiciones de tus campo.

Para mas información revisa la documentación oficial de Django en este link: Documentación oficial