Asciidoc mu html mi

belgeler

#1

Siteye yeni belge eklerken html mi kullanmalıyız yoksa asciidoc mu?
Eğer asciidoc kullanırsak html e dönüştürmek için nasıl bir yol izlemeliyiz?


#2

Sitemizde iki tür belge var:

  1. https://belgeler.yazbel.com/python-istihza/ adresindeki istihza Python 3 belgeleri. Bu belgeler reStructuredText kullanılarak yazılmıştır. GitHub veri havuzu şuradadır: https://github.com/yazbel/python-istihza
  2. https://belgeler.yazbel.com/ adresindeki YazBel belgeleri. Bu belgeler AsciiDoc ile yazılmıştır. GitHub veri havuzu adresi şuradadır: https://github.com/yazbel/belgeler

Eğer Python ile ilgili bir belge hazırlayacaksanız ilk belgelere ekleme yapmanızı öneririm. Eğer başka bir dille ilgili bir belge hazırlayacaksanız ikinci belgelere ekleme yapmanız gerek. Eklemeler her iki durumda da bu veri havuzlarına reStructuredText ya da AsciiDoc kullanılarak yapılmalı.

Not: istihza belgelerinin AsciiDoc sözdizimine çevrilmesi belgelerin tutarlılığı açısından iyi olacaktır. İlgili veri havuzunda bunun için şöyle bir iş açtık. İlgilenenleri bekleriz.


#3

Beautiful Soup modülü python ile ilgili olduğu halde belgeler kısmında da mevcut.
yani Beautiful Soup gibi üçüncü parti paketler hangi kısımda olacak?


#4

Haklısınız. Başta istihza belgelerine dokunmamayı düşünmüştüm. Ancak o zamandan bu yana istihza belgelerine katkılar oldu ve şimdi farklı düşünüyorum. YazBel belgelerinde zaten pek bir şey yok. Python ile ilgili olan belgeleri istihza belgelerine ekleyin.


#5

İstihza belgelerine yeni eklenecek olan bu belgeler reStructuredText formatında mı olacak yoksa asciidoc mu ?
Yani siteden reStructuredText formatı tamamen kaldırılacak mı?


#6

reStructuredText formatında olmalı.

Gönüllü birisi istihza belgelerini AsciiDoc formatına taşırsa reStructuredText’i siteden kaldırabiliriz, o zamana kadar kalacak. :slight_smile: