Документация по Python и JavaScript/AngularJS на одном сервере?

К преимуществам такого подхода относятся:

  • Единый синтаксис docstring везде
  • Централизованный сервер документации; найти все свои документы в одном месте
  • Поиск и переход к исходному коду из любой документированной функции или класса; на любом языке

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


python angularjs python-sphinx documentation-generation docstring
person A T    schedule 20.01.2014    source источник
comment
google.fr/search?q=sphinx+autodoc+javascript   -  person bruno desthuilliers    schedule 20.01.2014
comment
Я использую sphinx-jsapidoc (с тех пор, как я задал этот вопрос); и не слишком впечатлил. Я заработал, но не обрабатывает семантику (такую ​​как директивы и модули); и, кроме того, функция перехода к реализации кажется сломанной.   -  person A T    schedule 20.01.2014

Ответы (1)


arrow_upward
0
arrow_downward

Я не уверен, касается ли ваш вопрос общедоступной документации или внутренней документации некоторых ваших проектов.

Для первого вы хотите увидеть это: http://devdocs.io/

Кроме того, парсеры документов devdocs имеют открытый исходный код, поэтому вы сможете использовать их в своих проектах для создания пользовательских devdocs.io.

person Mikko Ohtamaa    schedule 20.01.2014