Документация Sphinx API для Javascript

Я широко использую Sphinx для документации и чувствую себя комфортно с ним.

Тем не менее, я больше занимался Javascript (внешний интерфейс), чем Python.

Существуют ли какие-либо подключаемые модули или способы создания аналогичной документации API из комментариев кода JavaScript в Sphinx, как и в строках документации Python?


person Mikko Ohtamaa    schedule 16.09.2012    source источник
comment
Вам может быть интересна эта тема в списке рассылки sphinx: группы. google.com/forum/?fromgroups#!topic/sphinx-dev/   -  person Markus Unterwaditzer    schedule 16.09.2012
comment
Аналогичный вопрос: stackoverflow.com/q/8644751/407651.   -  person mzjn    schedule 16.09.2012


Ответы (2)


У меня была та же проблема, поэтому я написал sphinx-js для ее решения. По сути, это автодок для JavaScript с некоторыми другими тонкостями. Существует более подробные сведения можно найти в блоге Mozilla Hacks. Преимущества по сравнению с аналогичными пакетами заключаются в лучшей полировке, отсутствии зависимости от Java, стандартном синтаксисе JSDoc в вашем исходном коде и рабочем процессе в стиле autodoc, а не на основе включения.

person Erik Rose    schedule 18.07.2017

Вы можете проверить jsdoc-for-sphinx. Я не пробовал, поэтому не знаю, насколько хорошо это работает.

person Juho Vepsäläinen    schedule 16.09.2012