Wie bekommt man Python-Dokumentation in Texinfo Info-Format?
https://stackoverflow.com/questions/1054903
-
20-08-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianFrage
Seit Python 2.6, so scheint es, die Dokumentation ist in dem neuen reStructuredText Format, und es scheint nicht sehr einfach, ein haddoc html-Dokumente zu sehen - ich möchte, dass sie in Info wirklich .
Ich habe gespielt mit Pandoc aber nach ein paar kleine Experimente scheint es nicht gut zu tun mit Verbindungen zwischen Dokumenten und meinem größeren Experiment - es über alle Dokumente laufen cat'ed zusammen, um zu sehen, was passiert - noch an zwei Tage tuckern, da ich es gestartet
Zwei gute Antworten
Hervorhebungen zwei Antworten unten, denn so wird mir nicht erlauben, beide Antworten zu akzeptieren:
- @ wilfred-hughes: von Melpa Installation der schnellste Weg, Informationen in Emacs zu bekommen pre-build
- @alioth: Gebäude it yourself wie sieht es viel einfacher als ist, wenn ich diese Frage im Jahr 2009 gefragt,
Lösung
Ich habe die Python-Dokumentation als texinfo Datei verpackt werden.
Wenn Sie Emacs mit Melpa verwenden, können Sie einfach installieren diese mit M-x package-install python-info.
Andere Tipps
Jon Waltman http://bitbucket.org/jonwaltman/sphinx-info hat sphinx gegabelt und ein texinfo Builder geschrieben, kann es die python-Dokumentation bauen (ich habe es noch nicht getan). Es scheint, dass es bald in sphinx zusammengeführt werden.
Hier ist die schnellen Links zu den Downloads (temporär):
Schritte Python doc in texinfo Format zu generieren:
Laden Sie den Python-Quelltext
Herunterladen und Installieren der Sphinx-info Paket (in einem virtualenv)
Geben Sie in dem Python / Doc-Verzeichnis aus dem Python Quellen
das Makefile bearbeiten, zu dem build Ziel ersetzen $(PYTHON) tools/sphinx-build.py mit sphinx-build, dann hinzufügen, um dieses Ziel in der Make-Datei, achten, der Raum vor dem Echo ist ein 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)."
Bearbeiten Sie die Python / Doc / conf.py fügte hinzu:
texinfo_documents = [
('contents', 'python', 'Python Documentation', 'Georg Brandl',
'Python', 'The Python Programming Language', 'Documentation tools',
1),
]
Dann laufen make texinfo und es sollte die texifile im Build / texinfo Verzeichnis erzeugen.
Um die Info-Datei laufen makeinfo python.texi zu erzeugen
Ohne Zweifel wäre es cool und anspruchsvoll sein, um die Python-Dokumentation auf Ihrem bestimmten Python-Version von sich selbst zu generieren. Folgen Sie einfach EmacsWiki , oder fühlen sich frei, um es lokal zu kompilieren (bei Debian Jessy für 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
Ich habe diesen Baum:
.
├── 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
Und jetzt ist es möglich, Python-Dokumentation nativ in Emacs von
BewertungC-u C-h i python-info RET
Python-info ist ein Dateiname (vierte in dem Baum oben) und sogar mit einem Lesezeichen versehen einige willkürliche Knoten für gewohnheitsmäßige und regelmäßige Überprüfung Komfort.
Für die folgenden, diese Frage in der Hoffnung auf eine Antwort, fand ich eine andere rst2texinfo Implementierung, die Sie versuchen mögen:
Eine weitere "Abhilfe" ist pydoc auszuführen, wie durch Nikokrock direkt in Emacs vorgeschlagen:
(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 verwendete Info-Formate von Python-Dokumentation zu erhalten:
http://www.cs.washington.edu/ Häuser / mernst / Software / # python-info
Sie können versuchen, seine Make-Datei und html2texi Skript mit einer aktualisierten Version zu erzeugen. Beide sind unter der obigen URL verknüpft. Ich bin mir nicht sicher, wie gut es funktioniert jetzt (die letzte Version um 2001), aber sein Drehbuch ist gut kommentiert (grep für „Python“).
Python-Dokumentation werden nun generiert Sphynx Framework. Dieser Rahmen hat nicht texinfo Ausgabeformat. Derzeit hat:
- HTML
- Latex
- Klartext
Vielleicht können Sie bekommen, was Sie den Latex ausgegeben werden soll verwenden. Mit der Textausgabe erhalten Sie den Querverweis verloren.
personnaly ich lieber mit pydoc wenn ich Textausgabe soll. Mit Vim habe ich ein shorcut pydoc anrufen und ein Fenster mit dem doc für die Entität unter meinem Cursor öffnen ...
