Como você recebe documentação Python em formato Texinfo Informações?
https://stackoverflow.com/questions/1054903
-
20-08-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianPergunta
Desde Python 2.6, parece que a documentação está no novo formato reStructuredText , e isso não parece muito fácil construir um Texinfo Informações arquivo fora da caixa mais.
Eu sou um viciado Emacs e prefiro a minha documentação instalada em Info.
Alguém tem Python 2.6 ou docs posteriores em formato Texinfo? Como você convertê-los? Ou, há uma construção em algum lugar mantido lá fora?
Eu sei que posso usar w3m ou haddoc para ver os documentos em HTML - Eu realmente quero que eles nos Informações .
Eu tenho jogado com Pandoc mas depois de algumas pequenas experiências não parecem lidar bem com links entre documentos, e minha experiência maior - executá-lo em todos os docs cat'ed juntos para ver o que acontece - ainda está chugging ao longo de dois dias desde que eu comecei-lo
Duas respostas boas
Destacando duas respostas abaixo, porque isso não vai permitir-me a aceitar ambas as respostas:
- @ Wilfred-Hughes: Instalando a partir Melpa é a maneira mais rápida para obter informações pré-construção em Emacs
- @alioth: Edifício-lo sozinho parece que é muito mais fácil do que quando eu fiz esta pergunta em 2009
Solução
Eu empacotados os docs Python como um arquivo texinfo .
Se você estiver usando Emacs com Melpa, você pode simplesmente instalar este com M-x package-install python-info.
Outras dicas
Jon Waltman http://bitbucket.org/jonwaltman/sphinx-info tem esfinge bifurcada e escrito um construtor texinfo, que pode construir a documentação python (eu ainda fez isso). Parece que serão fundidos em breve em esfinge.
Aqui estão os links rápidos para os downloads (temporárias):
Passos para gerar python doc em texinfo formato:
Faça o download do código-fonte python
Faça o download e instale o href="http://bitbucket.org/jonwaltman/sphinx-info" rel="noreferrer"> pacote sphinx-info
Entre no diretório Python / Doc das fontes python Edite o Makefile, para o alvo Edite o Python / Doc / conf.py acrescentando: Em seguida, execute build substituir $(PYTHON) tools/sphinx-build.py com sphinx-build, em seguida, adicione este destino para o makefile, preste atenção, o espaço antes de eco é um 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)."
texinfo_documents = [
('contents', 'python', 'Python Documentation', 'Georg Brandl',
'Python', 'The Python Programming Language', 'Documentation tools',
1),
]
make texinfo e deve produzir o texifile no build / texinfo diretório.
Para gerar o makeinfo python.texi informações arquivo run
Sem dúvida que seria legal e desafiador para gerar a documentação Python em sua versão particular Python por si mesmo. Basta seguir EmacsWiki , ou sentir-se livre para compilá-lo localmente (no 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
Eu tenho esta árvore:
.
├── 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 agora é possível documentação revisão python nativamente no Emacs por
C-u C-h i python-info RET
python-info é um nome de arquivo (em quarto lugar na árvore acima), e até mesmo para marcar alguns nós arbitrários para habitual e regular de conveniência revisão.
Para aqueles que seguem esta pergunta na esperança de uma resposta, eu encontrei outra implementação rst2texinfo que você pôde gostar de tentar:
Outra "solução alternativa" é executar pydoc como sugerido por Nikokrock diretamente no 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 usado para manter formatos de Informações de docs Python:
http://www.cs.washington.edu/ casas / mernst / software / # python-info
Você pode tentar usar seu makefile e roteiro html2texi para gerar uma versão atualizada. Ambos estão ligados na URL acima. Não tenho certeza como ele funciona bem agora (a última versão era por volta de 2001), mas o roteiro é bem comentado (grep para "python").
docs Python agora são gerados usando o framework Sphynx. Este quadro não tem texinfo formato de saída. Atualmente ele tem:
- HTML
- latex
- texto simples
Talvez você possa obter o que deseja usando a produção de látex. Com a saída de texto que você vai perder o árbitro cruz.
Personnaly eu prefiro usar pydoc quando quero saída textual. Com Vim Eu tenho um shorcut chamar pydoc e abrir uma janela com o doc para a entidade sob o meu cursor ...
