Django-online-docs Una aplicación de Django reutilizable que muestra la documentación para la vista que se muestra actualmente
Descargar ahora

Django-online-docs Clasificación y resumen

Django-online-docs Etiquetas

usuario Django documentación documentación del usuario

Django-online-docs Descripción

Django-Online-Docs es una aplicación DJANGO para mostrar la documentación del usuario en cada página de su proyecto. Mostigres grandes clientes solicita una documentación de usuario en el formato de Microsoft Word. Pensamos que esto es una locura porque desarrollamos aplicaciones web de una manera ágil, lo que significa que tal documentación estaría desactualizada casi de inmediato. También habría el problema para enviar la última documentación a todos los usuarios, por lo que pensamos, por qué no solo incluir la documentación de la página en sí. Y por qué no hacer que la documentación sea lo suficientemente inteligente para mostrar solo los documentos sobre la página que se muestra actualmente. Esta aplicación resuelve la URL actual y intenta cargar un archivo de descuento para la vista que se muestra actualmente en un modal de jQuery. Los archivos simplemente deben almacenarse en su aplicación / estática / online_docs / carpetas. Ahora, todo lo que tiene que hacer es Ejecutar ./manage.py colectstatic y esta aplicación debe poder encontrar sus archivos de documentación. Tenga en cuenta que este es un Primer prototipo y prueba de concepto para esta idea. Es muy simplista y probablemente se vuelve seco y no es compatible con I18N. Aunque está en la hoja de ruta, aunque.Instalationif que desea instalar la última versión estable de PYPI: PIP Instale Django-Online-Docsif que se siente aventurero y desea instalar la última confirmación de GitHub: PIP Install -e git: // GitHub. com / bitmazk / django-online-docs.git # huev = online_docsadd online_docs a su install_apps: instally_apps = (..., 'online_docs',) Agregue jquery y jquery-ui y online_docs.js a su base.html. Además, online_docs / CSS / STYLES.CSS le dará algunos estilos simples para la salida que genera la marca. Puede dejar salir esta hoja de estilo y simplemente agregar los estilos a su propia hoja de estilo principal si desea: ... ... ... >