Я ищу инфраструктуру документирования Javascript API с функциями, похожими на JSDoc, но в комментариях к коду будет использоваться легко набираемый текст или уценка (не в формате html)
Бонус: хорошо интегрируется сSphinx.Однако я не хочу вести отдельную документацию, а генерировать документацию API из комментариев.
http://code.google.com/p/jsdoc-toolkit/
Я наконец нашел JSDuck наиболее подходящим для этой задачи:
https://github.com/senchalabs/jsduck
InvisibleJS поддерживает уценку и ряд других форматов.
Также взгляните на docco .
Для тех, кто все еще ищет плагин уценки для jsdoc-toolkit, пожалуйста, взгляните на плагины под названием 'smartdown' в следующих ссылках
https://github.com/sproutcore/docs
(Подробнеессылка на синтаксис: http://guides.sproutcore.com/documentation_guidelines.html)
Я пробовал это с sphinx через следующие шаблоны (jsdoc-toolkit-rst-template, jsdoc-for-sphinx), и это работает безупречно.
JSDoc 3 теперь поддерживает уценку с помощью плагина. Вы можете настроить поддержку уценки, добавив строку
"plugins": [ "plugins/markdown" ],
в файл конфигурации JSON.
Теперь запуск JSDoc с -c conf.json включит поддержку уценки.
-c conf.json