Django-online-docs Un'app Django riutilizzabile che mostra la documentazione per la vista attualmente visualizzata
Scarica ora

Django-online-docs Classifica e riepilogo

Django-online-docs Tag

utente Django documentazione Documentazione dell'utente

Django-online-docs Descrizione

Django-Online-Docs è un'app Django per mostrare la documentazione dell'utente in ogni pagina del tuo progetto. I più grandi clienti richiedono una documentazione utente in formato Microsoft Word. Pensavamo che questo sia pazzo perché sviluppiamo applicazioni web in modo agile, il che significa che una tale documentazione sarebbe stata obsoleta quasi immediatamente. Ci sarebbe anche il problema per inviare l'ultima documentazione a tutti gli utenti, quindi abbiamo pensato perché non includere semplicemente la documentazione sulla pagina stessa. E perché non rendere la documentazione abbastanza intelligente da mostrare solo i documenti sulla pagina attualmente visualizzata.Questa app risolve l'URL corrente e tenta di caricare un file Markdown per la vista attualmente visualizzata in un jQuery Modal. I file devono semplicemente essere memorizzati nelle tue app / statiche / online_docs / cartelle. Ora è necessario eseguire ./manage.py.pyStatic e questa app dovrebbe essere in grado di trovare i file di documentazione. Sii consapevole che questo è un Primo prototipo e prova del concetto per questa idea. È molto semplicistico e probabilmente viola secco e non supporta I18n. Questo è sulla roadmap, però.Installazione, vuoi installare l'ultima versione stabile da Pypi: PIP Installa Django-Online-Docsif ti senti avventuroso e vuoi installare l'ultimo commit da GitHub: PIP Install -e Git: // GitHub. com / bitmazk / django-online-docs.git # uovo = online_docsadd online_docs ai tuoi installati_apps: installato_apps = (..., 'online_docs',) Aggiungi jQuery e jquery-ui e online_docs.js al tuo base.html. Inoltre online_docs / css / styles.css ti darà alcuni stili semplici per l'output generata da markdown. Puoi lasciare questo foglio di stile e aggiungere gli stili al tuo foglio di stile principale se vuoi: ... ... ... tag ->