tutorial - ¿Cómo se obtiene la documentación de Python en formato de información de Texinfo?

python tutorial (7)

He empaquetado los documentos de Python como un archivo texinfo .

Si está utilizando Emacs con MELPA, simplemente puede instalarlo con Mx package-install python-info .

Desde Python 2.6, parece que la documentación está en el nuevo formato reStructuredText , y no parece muy fácil construir un archivo Info de Texinfo listo para usar.

Soy un adicto a Emacs y prefiero que mi documentación esté instalada en Info.

¿Alguien tiene documentos de Python 2.6 o posteriores en formato Texinfo? ¿Cómo los convertiste? O bien, ¿hay una construcción mantenida en algún lugar?

Sé que puedo usar w3m o haddoc para ver los documentos html. Realmente los quiero en Info.

He jugado con Pandoc pero después de algunos experimentos pequeños no parece funcionar bien con los enlaces entre los documentos, y mi experimento más extenso, ejecutarlo en todos los documentos cateados para ver qué pasa, todavía dura dos días ¡desde que lo comencé!

Dos buenas respuestas

Resaltando dos respuestas a continuación, porque SO no me permitirá aceptar ambas respuestas:

@ wilfred-hughes: la instalación desde MELPA es la forma más rápida de obtener información previa a la construcción en Emacs
@alioth: construirlo tú mismo parece que es mucho más fácil que cuando hice esta pregunta en 2009

Jon Waltman http://bitbucket.org/jonwaltman/sphinx-info ha bifurcado sphinx y ha escrito un constructor de texinfo, puede construir la documentación de python (aún lo he hecho). Parece que pronto se fusionará con la esfinge.

Aquí están los enlaces rápidos para las descargas (temporales):

Pasos para generar python doc en formato texinfo:

Descargue el código fuente de Python

Descargue e instale el paquete http://bitbucket.org/jonwaltman/sphinx-info (en un virtualenv)

Ingrese en el directorio de Python / Doc desde las fuentes de Python

Edite el Makefile, para el objetivo de build reemplace $(PYTHON) tools/sphinx-build.py con sphinx-build , luego agregue este objetivo al archivo MAKE, preste atención, el espacio antes de que echo sea un TAB:

texinfo: BUILDER = texinfo texinfo: build @echo @echo "Build finished. The Texinfo files are in _build/texinfo." @echo "Run /`make'' in that directory to run these through makeinfo" / "(use /`make info'' here to do that automatically)."

Edite Python / Doc / conf.py agregando:

texinfo_documents = [ (''contents'', ''python'', ''Python Documentation'', ''Georg Brandl'', ''Python'', ''The Python Programming Language'', ''Documentation tools'', 1), ]

Luego ejecuta make texinfo y debe producir el archivo texifile en el directorio build / texinfo. Para generar el archivo de información ejecuta makeinfo python.texi

Los documentos de Python ahora se generan utilizando Sphynx framework. Este marco no tiene formato de salida texinfo. Actualmente tiene:

HTML
látex
Texto sin formato

Tal vez puedas obtener lo que quieras usando la salida Latex. Con la salida de texto, perderá la referencia cruzada.

Personalmente prefiero usar pydoc cuando quiero salida de texto. Con Vim tengo un shorcut para llamar a pydoc y abrir una ventana con el documento para la entidad bajo mi cursor ...

Michael Ernst solía mantener formatos de información de Python docs:

http://www.cs.washington.edu/homes/mernst/software/#python-info

Puede intentar usar su script makefile y html2texi para generar una versión actualizada. Ambos están vinculados en la URL anterior. No estoy seguro de qué tan bien funciona ahora (la última versión fue alrededor de 2001), pero su guión está bien comentado (grep para "python").

Otra "solución alternativa" es ejecutar pydoc según lo sugerido por Nikokrock directamente en Emacs:

(defun pydoc (&optional arg) (interactive) (when (not (stringp arg)) (setq arg (thing-at-point ''word))) (setq cmd (concat "pydoc " arg)) (ad-activate-regexp "auto-compile-yes-or-no-p-always-yes") (shell-command cmd) (setq pydoc-buf (get-buffer "*Shell Command Output*")) (switch-to-buffer-other-window pydoc-buf) (python-mode) (ad-deactivate-regexp "auto-compile-yes-or-no-p-always-yes") )

Para aquellos que siguen esta pregunta con la esperanza de obtener una respuesta, encontré otra implementación de rst2texinfo que te gustaría probar:

http://bitbucket.org/jonwaltman/rst2texinfo/src

Sin duda, sería genial y desafiante generar la documentación de Python en su versión particular de Python por su cuenta. Simplemente siga EmacsWiki , o siéntase libre de compilarlo localmente (en Debian Jessy para Python3.4.2):

sudo apt-get install python3-sphinx cd ~/Desktop wget https://www.python.org/ftp/python/3.4.2/Python-3.4.2rc1.tar.xz tar -xf Python-3.4.2rc1.tar.xz cd Python-3.4.2rc1/Doc/ sphinx-build -b texinfo -d build/doctrees . build/texinfo # extra time to build cd build/texinfo/ makeinfo python.texi # extra time for convertation

Tengo este árbol:

. ├── logging_flow.png ├── Makefile ├── pathlib-inheritance.png ├── python.info ├── python.info-1 ├── python.info-10 ├── python.info-11 ├── python.info-12 ├── python.info-13 ├── python.info-14 ├── python.info-15 ├── python.info-16 ├── python.info-17 ├── python.info-18 ├── python.info-19 ├── python.info-2 ├── python.info-20 ├── python.info-21 ├── python.info-22 ├── python.info-23 ├── python.info-24 ├── python.info-25 ├── python.info-26 ├── python.info-27 ├── python.info-28 ├── python.info-29 ├── python.info-3 ├── python.info-30 ├── python.info-31 ├── python.info-32 ├── python.info-33 ├── python.info-34 ├── python.info-4 ├── python.info-5 ├── python.info-6 ├── python.info-7 ├── python.info-8 ├── python.info-9 ├── python.texi ├── python-video-icon.png ├── tulip_coro.png └── turtle-star.png

Y ahora es posible revisar la documentación de Python de forma nativa en Emacs por

Cu Ch i python-info RET

python-info es un nombre de archivo (el cuarto en el árbol de arriba), e incluso para marcar algunos nodos arbitrarios para una conveniencia de revisión habitual y habitual.