Рабочий процесс документации Sphinx и JavaScript [закрыт]

Для моего JavaScript-фреймворка я хотел бы использовать Sphinx. Поскольку я новичок в мире Sphinx, я бы хотел, чтобы вы помогли мне начать работу со Sphinx и JavaScript.


python javascript python-sphinx restructuredtext
person Software Enthusiastic    schedule 27.12.2011    source источник

Ответы (2)


arrow_upward
1
arrow_downward

Я полагаю, что вам нужна функция JavaScript-домен Sphinx.

Редактировать. Судя по документации и инструментам, вы не можете использовать ReST внутри своего JavaScript. Вам придется либо выуживать документацию из комментариев, либо хранить ее в файлах sidecar-файлов.

person Morten Siebuhr    schedule 27.12.2011
comment
Это нормально, я не хочу использовать ReST внутри моей библиотеки JavaScript, было бы хорошо, если бы все члены библиотеки автоматически обнаруживались вместе с соответствующими комментариями сфинкса. - person Software Enthusiastic; 28.12.2011
comment
Я не совсем понимаю; «автоопределение членов библиотеки» и «связанные комментарии сфинкса»? Насколько я знаю, Sphinx вообще не умеет читать JavaScript-код, поэтому он не может разобрать для вас ни функции, ни связанную с ними документацию. Вот почему я предложил использовать файлы sidecar. - person Morten Siebuhr; 28.12.2011
comment
Это отсроченный ответ на это, но я искал, сделал ли это кто-то другой. Когда я ничего не мог найти, я просто что-то строил. github.com/Nuulogic/sphinx-jsapidoc Я бы назвал его альфа-версией, и это очень, очень специфичен в отношении используемого вами синтаксиса -- требуется чистый javascript. Я протестировал его только на внутреннем коде компании, в которой работаю, но у нас он работает довольно надежно. - person oliverseal; 27.07.2012

arrow_upward
0
arrow_downward

Извините за слишком поздний ответ)

Как и вы, я хочу создавать документы для своего собственного JS-фреймворка на основе AngularJS.

И, как и oliverseal, я создал расширение sphinx нативным способом для sphinx и ext.autodoc sphinxcontrib-autoanysrc

Он простой и чистый, но имеет функции ext.autodoc для автоматической генерации подписей и других, но мне достаточно хранить reST-документы API фреймворка в js-файлах)

Вы можете реализовать функции ext.autodoc с помощью расширения sphinxcontrib-autoanysrc. " rel="nofollow">autoanysrc.JSAnalyzer

person estin    schedule 23.10.2014