Texinfo Info 형식으로 Python 문서를 어떻게 얻습니까?
-
20-08-2019 - |
문제
Python 2.6 이후로 문서가 새로운 것 같습니다. 구조 조정 텍스트 형식, 그리고 건축하기가 쉽지 않은 것 같습니다. Texinfo 정보 더 이상 상자 밖으로 파일을 파일하십시오.
저는 EMACS 중독자이며 정보에 설치된 내 문서를 선호합니다.
Texinfo 형식으로 2.6 이상의 문서가있는 사람이 있습니까? 어떻게 변환 했습니까? 아니면 어딘가에 유지 된 빌드가 있습니까?
나는 W3M을 사용할 수 있다는 것을 안다 Haddoc HTML 문서를 보려면 정보를 실제로 원합니다.
나는 함께 놀았다 팬닥 그러나 몇 가지 작은 실험 후에 문서 간의 링크를 잘 다루지 않는 것 같습니다. 그리고 내 큰 실험 - 모든 문서를 가로 질러 실행하여 어떻게 일어나는지 확인합니다.
두 가지 좋은 답변
아래 두 가지 답변을 강조합니다. 그래서 두 가지 답변을 모두 받아 들일 수 없기 때문입니다.
- @Wilfred-Hughes : Melpa에서 설치 EMAC에 사전 건축 정보를 얻는 가장 빠른 방법입니다.
- @Alioth : 직접 구축 2009 년 에이 질문을했을 때보 다 훨씬 쉬운 것 같습니다.
해결책
나는 포장했다 Texinfo 파일로서 Python 문서.
Melpa와 함께 EMAC를 사용하는 경우 M-x package-install python-info
.
다른 팁
Jon Waltman http://bitbucket.org/jonwaltman/sphinx-info 스핑크스를 포기하고 Texinfo 건축업자를 작성하여 Python 문서를 작성할 수 있습니다 (아직 해냈습니다). 곧 스핑크스로 합병 될 것 같습니다.
다음은 다운로드에 대한 빠른 링크입니다 (임시).
Texinfo 형식으로 Python Doc을 생성하는 단계 :
Python 소스 코드를 다운로드하십시오
다운로드하고 설치하십시오 스핑크스 인포 패키지 (virtualenv)
Python 소스에서 Python/Doc 디렉토리를 입력하십시오.
makefile을 편집하십시오 build
대상 교체 $(PYTHON) tools/sphinx-build.py
~와 함께 sphinx-build
, 그런 다음이 대상을 makefile에 추가하고,주의를 기울이십시오. Echo의 공간은 다음과 같습니다.
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)."
Python/doc/conf.py 추가 : 편집 :
texinfo_documents = [
('contents', 'python', 'Python Documentation', 'Georg Brandl',
'Python', 'The Python Programming Language', 'Documentation tools',
1),
]
그런 다음 실행하십시오 make texinfo
Build/Texinfo 디렉토리에서 Texifile을 생성해야합니다. 정보 파일 실행을 생성합니다 makeinfo python.texi
의심 할 여지없이 특정 Python 버전에서 직접 파이썬 문서를 생성하는 것은 시원하고 어려울 것입니다. 그냥 따라 가라 Emacswiki, 또는 자유롭게 컴파일하십시오 (Python3.4.2의 Debian Jessy에서) :
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
나는이 나무를 얻었다 :
.
├── 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
이제 Python 문서를 검토 할 수 있습니다 기본적으로 Emacs ~에 의해
cu ch i python-info ret
Python-Info는 파일 이름 (위의 트리에서 네 번째)이며 습관적이고 정기적 인 편의를 위해 임의의 일부 노드를 북마크합니다.
답변의 희망 으로이 질문을 따르는 사람들을 위해, 나는 당신이 시도하고 싶은 또 다른 rst2texinfo 구현을 발견했습니다.
또 다른 "해결 방법"은 실행하는 것입니다 pydoc
Nikokrock이 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는 파이썬 문서의 정보 형식을 유지하는 데 사용되었습니다.
http://www.cs.washington.edu/homes/mernst/software/#python-info
그의 makefile 및 html2texi 스크립트를 사용하여 업데이트 된 버전을 생성 할 수 있습니다. 둘 다 위의 URL에 연결되어 있습니다. 나는 그것이 얼마나 잘 작동하는지 잘 모르겠지만 (마지막 버전은 2001 년경) 그의 대본은 잘 댓글을 달았습니다 ( "Python"의 경우 grep).
Python 문서는 이제 Sphynx 프레임 워크를 사용하여 생성됩니다. 이 프레임 워크에는 Texinfo 출력 형식이 없습니다. 현재 :
- HTML
- 유액
- 일반 텍스트
라텍스 출력을 사용하여 원하는 것을 얻을 수 있습니다. 텍스트 출력을 사용하면 Cross Ref를 잃게됩니다.
Personaly 텍스트 출력을 원할 때 PYDOC를 사용하는 것을 선호합니다. VIM과 함께 Pydoc에게 전화를 걸고 커서 아래 엔터티의 문서와 함께 창을 열 수있는 해안이 있습니다 ...