7
Başlık, her şeyi açıklıyor. Hayal ettiğim şey, tüm modüllerim, sınıflarım ve işlevlerim için belge dizileri kullanmaktır ve bir şekilde github (wiki?) Aracılığıyla dokümana güzelce gitmektedir. Ayrıca, dokümanın, güncellendiğinde/yeniden oluşturulduğunda anlamlandırılması gereken en son kodla eşleşmesi gerekir. Mümkün mü?Python Docstrings öğesinden GitHub Wiki Belgelerini Otomatik Olarak Oluştur
Sfenks, kesinlikle öyle. Markdown için, mkdocs var, ama bu docstrings'i desteklemiyor. Yine de, bu denemeye başladım (bu kötü bir fikir olabilir): https://github.com/waylan/mddoc – Waylan
Aynı problemi yaşadım ([readme.md] (https://github.com/matteoferla/ mutajenez)) ve güzel bir cevap olduğuna inanmıyorum. Ben mkdocs denedim - sadece benim klasör kirli - ve [pydoc_markdown] (https://github.com/NiklasRosenstein/pydoc-markdown), pydoc metnin bir kısmını verdi üst Google hit verdi. Sonunda sadece pydoc çıktısını aldım ve üç veya dört arama yaptım ve birkaç öğeyi değiştirdim. –
Github per-repo wiki'lerinin ana repo işlerine bağlı olmadığını fark ettik. Yani, her bir taahhütlü dokümantasyonun doğru olmasını istiyorsanız (bu şekilde kontrol edilen herhangi bir belgenin doğru dokümana sahip olması gerekir) Repo wiki işe yaramaz. –