2011-06-13 15 views
5

için Belgeleri otomatik olarak oluştur Kullanım admindocs seporate içinde kendi modelleri ve görünümleri ve ben fonksiyonlar için .py dosyalarıDjango - Kendi Kanunu

cevap

4

mümkün HTML/PDF belgeleri oluşturmak için django.contrib.admindocs paketi kullanmak için bir yol tasarımda mı - - Az önce HTML oluşturmak için Python Sfenks http://sphinx.pocoo.org/

hemen hemen standardına daha iyi olabilir sizin piton dosyalarından kullanıcı dostu belgeler oluşturmak için arıyorsanız dosyalarınız için docs

yapılandırılmıştır bağlıdır dokümantasyon - aynı sistem ReadTheDocs üzerinde

+0

Daha sonra, django admin ile derlenmiş sfenks html dokümanlarını bağlayabilir misiniz, böylece sadece çalışan kullanıcılar bunları görebilir? – littlepea

+1

çift yolu, ilk olarak bir sphinx docs'ı bir şablon klasörüne kopyalamanız ve bu dizini yalnızca personel için kısıtlamalarla eşleyen bir özel URL/görünüm oluşturuyor - sonra yönetici şablonunda bu bölüme bir bağlantı ekleyin - muhtemelen Bunu başarmak için daha zarif yollar ama bir başlangıç ​​noktası sağlar – Alvin

+1

Teşekkürler Alvin! Aslında tam olarak bu amaçla yeniden kullanılabilir bir uygulama yaptım: [django-docs] (http://django-docs.readthedocs.org/en/latest/);) – littlepea