JavaScript çerçevem için Sphinx'i kullanmak istiyorum. Sfenks dünyasında yeni olduğum için, Sfenks ve JavaScript ile çalışmaya başlamanıza yardımcı olmanızı istiyorum.Sfenks ve JavaScript Dokümantasyon İş Akışı
Herhangi bir yardım için teşekkür ederiz.
Saygılarımızla
Sana JavaScript Domain özelliği 'Sfenks aradığınız inanıyoruz.
Düzenleme: Hızlı bir glean dokümanı dokümantasyondan & araçlarına, bu Rehavent JavaScript'inizin içinde kullanabilirsiniz gibi görünmüyor. Dokümanları yorumlardan çıkarmanız veya yan dosyalarda saklamanız gerekir. çok geç yanıt için üzgünüm
)
Senin gibi ben angularjs dayalı kendi JS çerçevesi için dokümanlar oluşturmak istiyorum.
Ve benzeri oliverseal, ben Sfenks ve ext.autodoc için doğal yolla sfenks uzantısı inşa ediyorum sphinxcontrib-autoanysrc
Çok basit ve temiz, ancak otomatik nesil imzalar ve diğerleri için ext.autodoc özellikleri var, ama yeterince beni autoanysrc.JSAnalyzer
kontrol Sen sphinxcontrib-autoanysrc uzantılı ext.autodoc özelliklerini uygulayabilir
js dosyalarında çerçeve API) geri kalanı docs depolamak için bu alanı özelliğini gördük, ama emin nasıl başlarım değil söyledi. –
Thats fine, ben JavaScript kütüphanem içinde ReST kullanmak istemiyorum, tüm kütüphane üyeleri otomatik olarak sphinx tarafından ilişkili yorumlar ile birlikte tespit edilirse, iyi olurdu. –
Tam olarak takip etmiyorum; »Kütüphaneyi« üyeleri ve »ilgili yorum yapan sphinx tarafından otomatik olarak algılanır«? AFAIK, Sphinx, JavaScript kodunun nasıl okunacağını bilmez, bu nedenle sizin için işlevleri veya ilişkili belgeleri ayrıştırılamaz. Bu yüzden sidecar dosyalarının kullanımını önerdim. –