Sphinx ile Belgelendirme ve GitLab Entegrasyonu
Artistanbul olarak kod kalitesine önem veriyoruz ve her projenin belgelemesinin doğru yapılmasını istiyoruz. Bunlar yapılırken birden fazla proje üzerinde çalışıldığı için her geliştiricinin tekrarladığı işler olduğunu fark ettik. Bu işlerden en önemlisi, dizin ve dosya yapısı ile beraber belgelemenin nasıl yapılacağı idi. Bu problemi çözmek için GitLab’ın sunduğu şablon repo özelliğini kullandık. Özetle, GitLab üzerinde yeni proje açılırken önceden açılmış bir repoyu ilk commit olarak kullanabiliyorsunuz. Bu da size herkesin kullanabileceği bir şablon oluşturarak, tekrarlayan işlerin önüne geçmenizi sağlıyor. Bu blog girdisinde Sphinx ile Python projeleri için nasıl belgeleme yapılacağını, GitLab entegrasyonunu, kod örneklerini, dizin yapısını ve hazır ayar dosyalarını bulacaksınız.