2011-05-18 108 views
7

Emacs自稱自我記錄。這意味着您可以使用Emacs來讀取在Emacs-Lisp文件中編碼的文檔。如何從Emacs Lisp文檔生成HTML?

是否有一種簡單的方法將本文檔導出爲HTML,以便將文檔放置在網站上?我知道FSF在http://www.gnu.org/software/emacs/manual/emacs.html上發佈文檔,但並不是所有的Emacs模塊都在那裏列出。

更新:我對elisp文件中的文檔感興趣,而不是texinfo文件中。我也想要這些功能和「主要模式」的文檔。在Emacs文檔查看器中,這是非常好的超鏈接,如果它保存在HTML中,它會很好。

+1

http://www.emacswiki.org/emacs/Htmlize – Drew 2011-08-20 01:59:13

+0

請訪問http:// kitchingroup.cheme.cmu.edu/blog/2014/10/17/Generate-emacs-lisp-documentation/。這裏有一些代碼可以將emacs lisp文檔的組織緩衝區轉換爲html或pdf。 – 2014-10-25 00:57:41

回答

1

我不認爲該文檔是「編碼在Emacs-Lisp文件中」。它們存儲爲texinfo文檔,可以導出爲HTML(我認爲GNU文檔網站是如何生成的)。 texi2html可以將texinfo文件轉換爲HTML。

函數的文檔字符串直接存儲在elisp文件中。如果你想要這些,你必須迭代函數列表,獲取文檔字符串並創建一個HTML文件。我認爲這應該是可行的幾行elisp。

Xah Lee評論here他們應該如何使用HTML。

+1

如果你能幫助到達elisp的這幾行,那將是非常好的。 – Philippe 2011-05-18 09:47:58

1

部分答案可能是簡單地使用/擴展現有的Lisp自動文檔生成器。這裏有可能讓你有幾個環節:

+1

這些都不是elisp嗎? – 2011-05-19 18:12:04

+0

不,他們是爲Common Lisp。這就是我的意思是「使用/擴展」;一種選擇是採取更「主流」的CL autodoc工具並破解它來正確解析elisp。可能比從頭開始的努力少。 – semperos 2011-05-19 21:51:59