2011-05-18 24 views
7

Emacs se autodenomina autodenominación. Esto significa que puede usar Emacs para leer la documentación codificada en los archivos de Emacs-Lisp.¿Cómo generar HTML a partir de la documentación de Emacs Lisp?

¿Existe alguna manera fácil de exportar esta documentación a HTML para que la documentación se pueda colocar en un sitio web? Sé que la FSF publica la documentación en http://www.gnu.org/software/emacs/manual/emacs.html, pero no todos los módulos de Emacs se enumeran allí.

Actualización: Me interesa la documentación en los archivos elisp, no en los archivos texinfo. También quiero la documentación para las funciones y para el "modo principal". En el visor de documentación de Emacs, todo esto está muy bien hipervinculado y sería genial si se conservara en HTML.

+1

http://www.emacswiki.org/emacs/Htmlize – Drew

+0

Ver http: // kitchingroup.cheme.cmu.edu/blog/2014/10/17/Generate-emacs-lisp-documentation/. Hay algún código allí que hará un buffer orgánico de la documentación de emacs lisp que se puede convertir a html o pdf. –

Respuesta

1

No creo que la documentación esté "codificada en archivos Emacs-Lisp". Se almacenan como documentos texinfo que se pueden exportar a HTML (que es, creo, cómo se genera el sitio de documentación de GNU). texi2html puede convertir archivos texinfo en HTML.

Las docstrings para las funciones se almacenan en los archivos elisp directamente. Si quieres eso, tendrás que recorrer la lista de funciones, obtener la docstring y crear un archivo HTML. Creo que debería ser factible en algunas líneas de elisp.

Xah Lee comenta here sobre cómo deberían estar usando el HTML de todos modos.

+1

Sería genial si puede ayudar a llegar a esas pocas líneas de elisp. – Philippe

1

Parte de la respuesta puede ser simplemente usar/extender los generadores de documentación automáticos Lisp existentes. Aquí hay algunos enlaces que pueden llegar hasta allí:

+1

Ninguno de estos son para elisp son ellos? –

+0

No, son para Common Lisp. Eso es lo que quiero decir con "use/extend"; Una opción es tomar una herramienta autodoc CL más "main stream" y hackearla para analizar correctamente elisp. Probablemente sea menos esfuerzo que comenzar desde cero. – semperos

Cuestiones relacionadas