Как сгенерировать Ruby документацию, используя другой шаблон? - PullRequest
4 голосов
/ 01 апреля 2009

Я хочу сгенерировать Ruby документацию с hanna шаблоном.

Как это сделать? Или где его скачать, если он вообще есть?

Использование

rdoc -o ~/doc --inline-source --line-numbers --format=html --template=hanna

дает мне документы с отсутствующими методами. Кажется, что он не генерирует методы, написанные на C.

Ответы [ 4 ]

1 голос
/ 28 сентября 2009

В вашем исходном каталоге ruby ​​запустите

hanna -o --inline-source --line-numbers --format = html

0 голосов
/ 22 апреля 2010

Если вы используете rvm, это работает:

$ gem install hanna
$ cd ~/.rvm/src/ruby-1.8.6-p383
$ hanna -o doc/api --inline-source --line-numbers --fmt=html
$ open doc/api/index.html
0 голосов
/ 20 апреля 2009

Оказывается, вам просто нужно получить исходный код Ruby , распаковать его, а затем в исходном каталоге запустить что-то вроде этого:

rdoc -o <output path> --inline-source --line-numbers --format=html --template=hanna
0 голосов
/ 08 апреля 2009

gem install mislav-hanna

Тогда просто следуйте инструкциям в файле readme:

http://github.com/mislav/hanna/blob/8eaeb062fae276b19eb86fa302e9ee446a06eef8/README.markdown

...