django-online-docs Um aplicativo Django reutilizável que mostra a documentação para a exibição que é exibida atualmente
Baixe Agora

django-online-docs Classificação e resumo

django-online-docs Tag

do utilizador Django. documentação documentação do usuário

django-online-docs Descrição

Django-Online-Docs é um aplicativo Django para mostrar a documentação do usuário em todas as páginas do seu projeto. A maioria dos grandes clientes solicitam uma documentação do usuário no formato do Microsoft Word. Pensamos que isso é insano porque desenvolvemos aplicativos da Web de maneira ágil, o que significa que tal documentação estaria desatualizada quase imediatamente. Também haveria o problema para enviar a última documentação para todos os usuários, por isso pensamos porque não apenas incluir a documentação na própria página. E por que não tornar a documentação inteligente o suficiente para mostrar apenas os documentos sobre a página que está atualmente exibida. Esse aplicativo resolve o URL atual e tenta carregar um arquivo de marcação para a exibição exibida no momento em um modal do jQuery. Os arquivos simplesmente precisam ser armazenados no seu aplicativo / estático / online_docs / pastas.now Tudo que você precisa fazer é executado ./manage.py colecionstatic e este aplicativo deve ser capaz de encontrar seus arquivos de documentação.Por favor, esteja ciente de que este é um primeiro protótipo e prova de conceito para esta ideia. É muito simplista e provavelmente viola seco e não suporta i18n. Isto está no roadmap, embora.Installationif você deseja instalar o lançamento estável mais recente do PYPI: PIP INSTALAR DJANGO-ONLINE-DOCSIF Você se sente aventureiro e deseja instalar o mais recente commit do GitHub: PIP INSTALL - O Git: / github. com / bitmazk / django-online-docs.git # ovo = online_docsadd online_docs para o seu instalado_apps: instale_apps = (..., 'online_docs',) Adicionar jQuery e jquery-ui e online_docs.js ao seu base.html. Além disso, online_docs / css / styles.css lhe dará alguns estilos simples para a saída que a marcação gera. Você pode deixar fora esta folha de estilo e adicionar os estilos ao seu próprio estilo principal, se quiser: ... ... ... <-carregue esses scripts antes do fechamento tag ->