Para mi marco de JavaScript, me gustaría usar Sphinx. Como soy nuevo en el mundo de la esfinge, me gustaría que me ayuden a comenzar con Sphinx y JavaScript.Flujo de trabajo de documentación de Sphinx y JavaScript
Cualquier ayuda apreciada.
Saludos
Creo que usted está buscando Sphinx' JavaScript Domain función.
Edición: De un rápido vistazo a las herramientas de documentación &, no parece que pueda usar ReST dentro de su JavaScript. Deberá pescar la documentación de los comentarios o guardarla en los archivos de sidecar.
Lo siento por la respuesta demasiado tarde)
Al igual que yo quiero construir documentación para mi propio marco JS basado en AngularJS.
Y oliverseal como, yo estoy construido extensión de la Esfinge en forma nativa para esfinge y ext.autodoc sphinxcontrib-autoanysrc
Es sencillo y limpio, pero tiene características ext.autodoc para firmas de generación de automóviles y otros, pero es lo suficientemente para mí almacenar documentos resto del API del marco de archivos js)
puede implementar características ext.autodoc con extensión sphinxcontrib-autoanysrc echa un vistazo a autoanysrc.JSAnalyzer
he visto esta característica de dominio, pero no sabe cómo hago para empezar con ese. –
Eso está bien, no quiero usar ReST dentro de mi biblioteca JavaScript, sería bueno si todos los miembros de la biblioteca se detectan automáticamente junto con los comentarios asociados de la esfinge. –
No lo sigo del todo; »Detectar automáticamente« miembros de la biblioteca »y» comentarios asociados por sphinx «? AFAIK, Sphinx no sabe cómo leer el código JavaScript en absoluto, por lo que no puede analizar las funciones o la documentación asociada por usted. Es por eso que sugerí el uso de archivos sidecar. –