Как сгенерировать HTML из документации Emacs Lisp? - PullRequest
7 голосов
/ 18 мая 2011

Emacs называет себя самодокументирующим. Это означает, что вы можете использовать Emacs для чтения документации, закодированной в файлах Emacs-Lisp.

Существует ли простой способ экспортировать эту документацию в HTML, чтобы ее можно было разместить на веб-сайте? Я знаю, что FSF публикует документацию на http://www.gnu.org/software/emacs/manual/emacs.html, но не все модули Emacs перечислены там.

Обновление: Меня интересует документация в файлах elisp, а не в файлах texinfo. Я также хочу документацию для функций и для "основного режима". В средстве просмотра документации Emacs все это красиво связано с гиперссылками, и было бы замечательно, если бы оно было сохранено в HTML.

Ответы [ 2 ]

1 голос
/ 19 мая 2011

Часть ответа может заключаться в простом использовании / расширении существующих генераторов автоматической документации Lisp.Вот несколько ссылок, которые могут вас туда найти:

1 голос
/ 18 мая 2011

Я не думаю, что документация "закодирована в файлах Emacs-Lisp". Они хранятся в виде документов texinfo, которые можно экспортировать в HTML (я думаю, как создается сайт документации GNU). texi2html может конвертировать файлы texinfo в HTML.

Строки документов для функций хранятся непосредственно в файлах elisp. Если вам это нужно, вам придется перебрать список функций, получить строку документации и создать файл HTML. Я думаю, что это должно быть выполнимо в несколько строк elisp.

Xah Lee комментирует здесь о том, как они должны использовать HTML в любом случае.

...