Es thre una manera de utilizar el paquete django.contrib.admindocs
para generar documentación HTML/PDF para mis propios modelos y vistas y funciones que tengo en seporate .py
archivosDjango - Use admindocs para auto-generar la documentación para el propio código del
5
A
Respuesta
4
posible - - depende de la forma en la documentación para sus archivos se estructuran
Si usted está buscando para generar documentos de uso fácil de los archivos de pitón puede ser mejor con Python Sphinx http://sphinx.pocoo.org/
menos el estándar para la generación de HTML documentación - mismo sistema us ed en ReadTheDocs
Cuestiones relacionadas
- 1. Sphinx para la documentación del código php
- 2. Cmake para autogenerar código de ahorro
- 3. autogenerar la pantalla HTTP raspando código Java
- 4. Autogenerar documentación ficticia en el código fuente de Python en eclipse
- 5. documentación de código para python
- 6. Documentación del código Xcode
- 7. Configuración de Django para sphinx (documentación)
- 8. Documentación del código VBA para Excel Auto Complete
- 9. Javadoc para la documentación del proyecto
- 10. Use vim para buscar por código hexadecimal
- 11. Graphviz para la documentación
- 12. Evite el uso recursivo save() cuando use el apio para actualizar los campos del modelo Django
- 13. Use javascript para obtener el código html sin formato
- 14. Use DLR para ejecutar el código generado con CompileAssemblyFromSource?
- 15. No use System.out.println en el código del lado del servidor
- 16. Documentación automática del código de ColdFusion
- 17. Documentación del código de Visual Basic 6.0
- 18. Documentación básica para Rcpp
- 19. Documentación para el marcado del archivo de ayuda vim
- 20. ¿Cómo exporto la documentación del código en C#/VisualStudio 2008?
- 21. ¿Cómo obtener el identificador del módulo de mi propio código?
- 22. Documentación oficial para MVC3
- 23. ¿Qué archivos debo decirle a mi VCS que ignore cuando use Sphinx para la documentación?
- 24. git número de revisión en la documentación del código fuente
- 25. Marcando "uso de ejemplo" en la documentación del código
- 26. ¿Cómo escribir tu propio generador de código backend para gcc?
- 27. Python CMS para mi propio sitio web?
- 28. Documentación para comentarios sobre la documentación de Qt? Qt + Doxygen?
- 29. ASP.NET autogenerar aspx.designer.cs apague?
- 30. Cualquiera que use Django en la "Empresa"
¿Puede entonces conectar documentos sphinx html compilados con django admin para que solo los usuarios del personal puedan verlos? – littlepea
maneras par, primero pienso en copiar los documentos de esfinge a una carpeta de plantilla y crear una url/vista personalizada que mapea ese directorio con restricciones solo para el personal - luego agregue un enlace a esa sección en la plantilla de administrador - probablemente formas más elegantes para lograr esto, pero proporciona un punto de partida – Alvin
Gracias Alvin! De hecho, he creado una aplicación reutilizable para este propósito: [django-docs] (http://django-docs.readthedocs.org/en/latest/);) – littlepea