Come si fa a ottenere la documentazione di Python in Texinfo formato Info?
https://stackoverflow.com/questions/1054903
-
20-08-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianDomanda
Dato che Python 2.6, sembra che la documentazione è in una nuova reStructuredText formato, e non mi sembra molto semplice la creazione di un Texinfo Info file fuori dalla scatola più.
Io sono un Emacs tossicodipendente e preferisco la mia documentazione installato in Informazioni.
Qualcuno ha Python 2.6 o versione successiva di documenti in Texinfo formato?Come hai fatto a convertirli?O, c'è un mantenuto costruire da qualche parte là fuori?
So che posso utilizzare w3m o haddoc per visualizzare i documenti in html - voglio davvero loro Informazioni.
Io ho giocato con Pandoc ma dopo un paio di piccoli esperimenti, non mi sembra di trattare bene con i collegamenti tra i documenti, e il mio più grande esperimento - in esecuzione su tutti i documenti gatto cantando insieme a vedere cosa succede - è ancora chugging lungo due giorni da quando ho iniziato!
Due buone risposte
Per mettere in risalto due risposte di seguito, perché non mi permette di accettare entrambe le risposte:
- @wilfred-hughes: L'installazione da MELPA è il modo più veloce per ottenere la pre-build info in Emacs
- @alioth: Palazzo te sembra molto più facile rispetto a quando ho chiesto a questa domanda nel 2009
Soluzione
Ho confezionato il Python documenti come un file texinfo.
Se stai usando Emacs con MELPA, si può semplicemente installare questo con M-x package-install python-info.
Altri suggerimenti
Jon Waltman http://bitbucket.org/jonwaltman/sphinx-info ha inforcato la sfinge e scritto un texinfo builder, è possibile creare la documentazione di python (non ho ancora fatto).Sembra che sarà fusa appena sfinge.
Ecco il link veloce per il download (temporanei):
Per generare in python doc in texinfo formato:
Scaricare il codice sorgente python
Scaricare e installare il sfinge-info pacchetto (in un virtualenv)
Entrare in Python/Doc directory da python fonti
Modificare il Makefile, per il build target sostituire $(PYTHON) tools/sphinx-build.py con sphinx-build, quindi , aggiungete questo obiettivo per il makefile, di prestare attenzione, lo spazio prima eco è una SCHEDA:
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)."
Modificare il Python/Doc/conf.py l'aggiunta di:
texinfo_documents = [
('contents', 'python', 'Python Documentation', 'Georg Brandl',
'Python', 'The Python Programming Language', 'Documentation tools',
1),
]
Quindi eseguire make texinfo e dovrebbe produrre il texifile nel costruire/texinfo directory.Per generare il file info eseguire makeinfo python.texi
Senza dubbio sarebbe bello e stimolante per generare la documentazione di Python sul vostro particolare versione di Python da soli.Basta seguire EmacsWiki, o non esitate a compilare localmente (in Debian Jessy per 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
Ho ottenuto questo albero:
.
├── 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
E ora è possibile rivedere documentazione di python nativamente in Emacs da
C-u-C h i python-info RET
python-info è un nome di file (quarto nella struttura di cui sopra), e anche per segnalibro alcuni nodi arbitrari per abituale e regolare revisione di convenienza.
Per chi segue questa domanda nella speranza di una risposta, ho trovato un altro rst2texinfo attuazione, come si potrebbe provare:
Un'altra "soluzione" è quella di eseguire pydoc come suggerito da Nikokrock direttamente in 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 utilizzato per mantenere Info formati di Python-docs:
http://www.cs.washington.edu/homes/mernst/software/#python-info
Si può provare a utilizzare il suo makefile e html2texi script per generare una versione aggiornata.Entrambi sono legati all'URL indicato sopra.Io non sono sicuro di come funziona ora (l'ultima versione è stata intorno al 2001), ma la sceneggiatura è ben commentato (grep per "python").
Python documenti vengono generati utilizzando Sphynx quadro.Questo quadro non ha texinfo formato di output.Attualmente è:
- HTML
- lattice
- testo normale
Forse si può ottenere ciò che si desidera utilizzando il Lattice di uscita.Con il testo di output sono perso il cross ref.
Personnaly io preferisco usare pydoc quando voglio output testuale.Con Vim ho una shortcut di chiamata pydoc e apre una finestra con il doc per l'ente sotto il mio cursore...
