Evet Software Tech
Published in

Evet Software Tech

Read The Docs(Sphinx) için Github Yapılandırması

Dokümantasyon konusunu ele aldığımız bu geliştirme sürecinin üçüncü makalesi olarak bir önceki bölümde örneklediğimiz teknik dokümanı önce github hesabımıza yükleyeceğiz sonrasında Read the Docs altyapısı ile bağlayacağız. Bu sayede belirlediğimiz kriterler üzerinden ekip arkadaşlarımız veya açık kaynak bir proje söz konusuysa herhangi bir geliştirici github üzerinden bizim dokümanlarımızı geliştirmek adına pull requestler gönderebilirler.

Geliştirme sürecimizde izleyeceğimiz yoldan kısaca bahsettikten sonra hadi bu senaryoyu nasıl uygulayacağız bu sürece bir göz atalım.

Öncelikle ilk adım olarak bir git reposu oluşturuyoruz.

Repomuzu oluşturduktan sonra VS Code’a geçiyoruz ve projemizi github’a gönderecek olan işlemleri yapıyoruz.

Projemiz üzerinde Initialize Repository seçeneğini seçiyoruz.

Commit mesajımızı yazıyoruz ve projemizi geçiş bölgesine(staging area) taşıyoruz. Sonra git bash terminalimize gelip projemizi github’a yükleyecek olan kodlarımızı yazıyoruz.

Daha önce git ile çalışmadıysanız eğer ilk resimde göreceğiniz hızlı kurulum adımlarını takip edebilirsiniz.

Yine de buraya daha önce hazırladığım git github cheetsheet’i bırakıyorum. İçerisinde git ve github ile ilgili temel kodların ne işe yaradıklarına dair bilgilere erişebilirsiniz.

Projemizi Github’a yüklediğimize göre şimdi de Read the Docs platformu ile projemizi bağlayalım.

Kayıt olacağımız linki buraya bırakıyorum. Doğrudan github hesabınız ile de sisteme kayıt olabilirsiniz. https://readthedocs.org/accounts/signup/

Kayıt işlemlerimizi tamamladıktan sonra Dashboard ekranına geldiğimiz zaman karşımızda Import a Project seçeneğini göreceğiz.

Sonraki sayfada göreceğiniz refresh butonuna tıklıyoruz.

Bu işlem sonrasında github hesabımızda bulunan projelerin bir listesini göreceğiz.

Read the Docs platformu ile bağlamak istediğimiz projemizi seçiyoruz.

Bir sonraki adımda sistemde kayıtlı olmayan bir proje adıyla webhook ekleme işleminin başarıyla tamamlandığını görüyoruz.

Bağlama işlemlerini tamamlamış bulunuyoruz. View Docs butonuna tıklayarak dokümanımıza erişebiliriz. Aşağıya basit bir örnek link bırakıyorum.

Örnek olarak hazırladığımız dokümanı açtığımız zaman sağ üst köşede beliren Github’da Düzenle seçeneği geldiğini görüyoruz. Bu seçenek ile github üzerinden dokümanımız üzerinde geliştirmeler yapılabilir hale getirmiş bulunuyoruz.

Örnek bir değişiklik sırasında öncelikle bir pull request oluşur. Onay sonrasında Read the Docs ile repomuza otomatik olarak entegre olan CI/CD süreci işlenir ve bu işlemler özelinde değişikliklerimiz canlı dokümanımıza yansır.

Buraya kadar olan kısımda süreçlerimizi aslında tamamladık diyebiliriz. Bu noktada bir değişiklik yapalım ve bu sürecin nasıl işlediğini gözlemleyelim.

Dokümanımızın başlık kısmında bulunan v1 kısmını v2 olarak değiştirmek istiyorum. Bunun için;

Github üzerinden ilgili projemizin ilgili sayfasına geliyoruz yukarıda işaretlenmiş olan edit düğmesi ile düzenleme ekranımıza geçiyoruz.

Değişikliğimizi yapıyoruz ve commit gönderiyoruz.

Değişikliği ilettikten sonra readthedocs üzerinden projemizin build sekmesine geldiğimiz zaman ilgili süreçleri buradan izleyebilirsiniz.

Cloning
Installing
Building
Passed

Passed adımını gördüğümüz zaman dokümanımız üzerinde değişikliğin gerçekleştiğini gözlemleyebilirsiniz.

Bonus :)

Read the Docs bizlere özelleştirilmiş bir alt alan adı da sunuyor.

Böylelikle üçüncü makalemizinde sonuna geldik. Bu makalemizde de anlatacaklarım bu kadar. Keyifli kodlamalar.

Devam edeceğiz…

--

--

--

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store
Mustafa Dikyar

Mustafa Dikyar

Software Developer

More from Medium

How to Write Standard Operating Procedures

“Google Hacking” — The way you retrieve data from Google

What is Virtualization ?

How to fix Windows 10 Boot Error (Error code : 0xc000000d)