¿Cómo se puede obtener la documentación de Python en Texinfo Info formato?
https://stackoverflow.com/questions/1054903
-
20-08-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianPregunta
Dado que Python 2.6, parece que la documentación está en la nueva reStructuredText formato, y no parece muy fácil construir un Texinfo Info archivo de la caja más.
Soy un Emacs adicto y prefiero que mis documentación instalado en Info.
¿Alguien tiene Python 2.6 o posterior docs en formato Texinfo?¿Cómo convertir?O, ¿hay un mantenido construir en algún lugar ahí fuera?
Sé que puedo usar o w3m haddoc a la vista de la documentación html - realmente quiero en Info.
Yo he jugado con Pandoc pero después de un par de pequeños experimentos, parece que no manejan bien los vínculos entre documentos, y mi más grande experimento de ejecución a través de todos los documentos gato juntos a ver qué pasa - es todavía resoplando dos días desde que empecé!
Dos buenas respuestas
Destacando dos respuestas abajo, porque ASÍ no me permite aceptar ambas respuestas:
- @wilfred-hughes: La instalación de MELPA es la forma más rápida de obtener una pre-build info en Emacs
- @alioth: Edificio de ti mismo parece que es mucho más fácil que cuando hice esta pregunta en 2009
Solución
He empaquetado los documentos de Python como un archivo texinfo .
Si está utilizando Emacs con MELPA, simplemente puede instalarlo con M-x package-install python-info.
Otros consejos
Jon Waltman http://bitbucket.org/jonwaltman/sphinx-info ha bifurcada de la esfinge y escrito un texinfo generador, se puede construir la documentación de python (aún no he hecho).Parece que va a ser combinados pronto en la esfinge.
Aquí tienes los enlaces para las descargas (temporal):
Pasos para generar python doc en formato texinfo:
Descargar el código fuente de python
Descargar e instalar el sphinx-info paquete (en un virtualenv)
Entrar en Python/Doc directorio de las fuentes de python
Editar el archivo Makefile, a la build objetivo reemplazar $(PYTHON) tools/sphinx-build.py con sphinx-build, a continuación, agregue este destino para el archivo makefile, prestar atención, en el espacio antes de echo es una FICHA:
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)."
Editar el Python/Doc/conf.py añadiendo:
texinfo_documents = [
('contents', 'python', 'Python Documentation', 'Georg Brandl',
'Python', 'The Python Programming Language', 'Documentation tools',
1),
]
A continuación, ejecute make texinfo y debería producir el texifile en el build/texinfo directorio.Para generar el archivo de información de ejecución makeinfo python.texi
Sin duda, sería genial y desafiante generar la documentación de Python en su versión particular de Python usted mismo. 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
C-u C-h i python-info RET
python-info es un nombre de archivo (cuarto en el árbol de arriba), e incluso para marcar algunos nodos arbitrarios para la conveniencia de revisión habitual y regular.
Para aquellos que siguen esta pregunta con la esperanza de obtener una respuesta, encontré otra implementación de rst2texinfo que les gustaría probar:
Otra " solución alternativa " es ejecutar pydoc como sugiere 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")
)
Michael Ernst solía mantener formatos de información de documentos de Python:
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 script está bien comentado (grep para & Quot; python & Quot;).
Los documentos de Python ahora se generan utilizando el marco Sphynx. Este marco no tiene formato de salida texinfo. Actualmente tiene:
- HTML
- látex
- texto sin formato
Tal vez pueda obtener lo que desea utilizando la salida de 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 debajo de mi cursor ...
