2015-05-13 30 views
10

autodoc ve benzeri araçların kullanılması, bir kaynaktan kaynak belgelerini derlemenize olanak sağlar docstrings. Ancak, işlev veya sınıf Docstringler keyfi Rest bölüm başlıkları izin görünüyor ve hatayı üretir değildir: SEVERE: Unexpected section title.sphinx Şiddetli: beklenmedik bölüm başlığı - işlev yönergelerindeki isteğe bağlı başlıklar

Ben numpydoc olmadan numpy tarzı yönergeleri izleyerek belgelemeye çalışan benzer bir sorun encoutered: unexpected section title with sphinx is numpy the issue ve how does numpy process docstrings into sphinx documentation for parameters

İşte ancak, aslında JavaScript belgelediğim ve sadece bir docstringe keyfi bölüm başlıkları ve dinlenmek istiyorum.

JavaScript docstring'ini api: sphinx jsapidoc

cevap

0

Evet, gereksinim sorunlar oluşturabilmektedir bir docstringe içinde keyfi bölüm başlıkları ve dinlenme eklemek için; Bu gereksinim için sphinx-jsapidoc etkilidir.