Zeppelin Z. функциональная документация - PullRequest
0 голосов
/ 09 мая 2018

Я мог бы неправильно понять некоторую концепцию, но я пытаюсь выяснить, где находится документация для команды Zeppelin, например z.input, z.get или z.angularBind.
Я нашел документацию здесь:
Документы Zeppelin
Но это не технически, я хочу иметь описание метода, такого как тот, который найден в javadoc или pydoc. Но мне не удается найти это для специфического метода и функции Zeppelin.
Как я могу узнать возвращаемое значение и параметры всех этих функций.

1 Ответ

0 голосов
/ 15 мая 2018

Я не думаю, что документы публикуются как таковые в этом формате.Но это не мешает вам генерировать их самостоятельно

git clone https://github.com/apache/zeppelin
cd zeppelin
git checkout v0.7.3
cd zeppelin-interpreter
mvn javadoc:javadoc

Это даст некоторую ошибку, но просто проигнорирует их.Тогда apidocs будет доступен в zeppelin/zeppelin-interpreter/target/site/apidocs/index.html

API Docs

Редактировать:
Если вы столкнулись с ошибкой:

[...]JavaScript found in documentation comment.
[ERROR] Use --allow-script-in-comments to allow use of JavaScript.

Вы можете отредактировать скрипт zeppelin/zeppelin-interpreter/target/site/apidocs/javadoc.sh и отредактировать его, добавив параметр: --allow-script-in-comments, чтобы строка заканчивалась на:

javadoc --allow-script-in-comments @options @packages 
...