33 votes

Comment obtenir la documentation Python au format Texinfo Info?

Depuis la version 2.6 de Python, il semble que la documentation est dans le nouveau reStructuredText format, et il ne semble pas très facile de construire un Texinfo Info fichier de la boîte plus.

Je suis une Emacs addict et préfère ma documentation installée dans des informations.

Quelqu'un aurait-Python 2.6 ou version ultérieure docs en format Texinfo? Comment avez-vous convertir? Ou, est-il maintenu construire quelque part là-bas?

Je sais que je peux utiliser w3m ou haddoc pour afficher le code html docs - je vraiment envie de les avoir en Info.

J'ai joué avec Pandoc mais après quelques petites expériences, il ne semble pas bien avec des liens entre les documents, et ma plus grande expérience - en cours d'exécution à travers toutes les docs chat ed ensemble pour voir ce qui se passe est encore cahin-caha sur deux jours depuis que je l'ai commencé!

24voto

pygabriel Points 3678

Jon Waltman http://bitbucket.org/jonwaltman/sphinx-info a fourche sphinx et écrit un texinfo constructeur, il peut construire la documentation python (je n'ai pas encore fait). Il semble qu'il sera bientôt fusionné en sphinx.

Voici les liens directs pour les téléchargements (temporaire):

Étapes pour générer python doc en format texinfo:

Télécharger le code source python

Télécharger et installer le sphinx-info package (dans un virtualenv)

Entrez dans l'Python/répertoire Doc de python sources

Éditer le fichier Makefile, à l' build cible remplacer $(PYTHON) tools/sphinx-build.py avec sphinx-build, puis ajouter cet objectif pour les makefile, attention, l'espace avant l'écho est un ONGLET:

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)."

Modifier la Python/Doc/conf.py en ajoutant:

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

Ensuite, exécutez make texinfo et il doit produire les texifile dans la construction/texinfo répertoire. Pour générer de l'info, de l'exécution du fichier makeinfo python.texi

9voto

Wilfred Hughes Points 3507

J'ai empaqueté les documents Python sous forme de fichier texinfo .

Si vous utilisez Emacs avec MELPA, vous pouvez simplement l'installer avec M-x package-install python-info .

3voto

Matt Curtis Points 12454

Pour ceux qui suivent cette question dans l'espoir d'une réponse, j'ai trouvé une autre implémentation de rst2texinfo que vous aimeriez essayer:

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

2voto

wr. Points 1887

Une autre "solution de contournement" consiste à exécuter pydoc comme suggéré par Nikokrock directement dans 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")
)
 

2voto

ars Points 35803

Michael Ernst avait l'habitude de maintenir les formats Info des documents Python:

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

Vous pouvez essayer d'utiliser son makefile et son script html2texi pour générer une version mise à jour. Les deux sont liés à l'URL ci-dessus. Je ne sais pas à quel point cela fonctionne bien (la dernière version était vers 2001), mais son script est bien commenté (grep pour "python").

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X