Python ドキュメントを Texinfo Info 形式で入手するにはどうすればよいですか?
-
20-08-2019 - |
質問
Python 2.6 以降、ドキュメントは新しいバージョンにあるようです。 再構造化されたテキスト フォーマットを構築するのはそれほど簡単ではないようです Texinfo 情報 ファイルは箱から出してすぐに使えます。
私は Emacs の常習者で、ドキュメントは Info にインストールされることを好みます。
Python 2.6 以降の Texinfo 形式のドキュメントを持っている人はいますか?どのように変換しましたか?それとも、どこかにメンテナンスされたビルドはありますか?
w3m または ハドック HTML ドキュメントを表示するには、情報を実際に表示したいと思います。
一緒に遊んだ パンドック しかし、いくつかの小さな実験の後では、ドキュメント間のリンクをうまく処理できないようです。そして、私の大規模な実験 (すべてのドキュメントをまとめて実行して何が起こるかを確認する) は、開始してから 2 日経ってもまだ続いています。
良い答えが 2 つあります
SO では両方の回答を受け入れることができないため、以下の 2 つの回答を強調表示します。
- @ウィルフレッド・ヒューズ: MELPAからインストールする ビルド前の情報を Emacs に取得する最も簡単な方法です
- @アリオス: 自分で構築する 2009 年にこの質問をしたときよりもはるかに簡単になったようです
解決
私は、TexinfoファイルのようのPythonのドキュメントをパッケージ化しました。
あなたはMELPAでのEmacsを使っている場合は、、あなたは、単にM-x package-install python-info
でこれをインストールすることができます。
他のヒント
ジョン・ウォルトマン http://bitbucket.org/jonwaltman/sphinx-info Sphinx をフォークして texinfo ビルダーを作成すると、Python ドキュメントをビルドできます (私はまだそれを行っています)。近々スフィンクスに統合されるようです。
ダウンロード用のクイック リンクは次のとおりです (一時的)。
Python ドキュメントを texinfo 形式で生成する手順:
Pythonのソースコードをダウンロードする
ダウンロードしてインストールします スフィンクス情報 パッケージ (virtualenv 内)
Python ソースから Python/Doc ディレクトリに移動します。
Makefile を編集して、 build
ターゲット置換 $(PYTHON) tools/sphinx-build.py
と sphinx-build
, 次に、このターゲットをメイクファイルに追加します。エコーの前のスペースが 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)."
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のバージョンのPythonドキュメントを生成するためにクールで挑戦することでしょう。ただ、 EmacsWiki に従う、または(Python3.4.2用Debianジェシーで)ローカルにそれをコンパイルして自由に感じます:
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での
により、C-U C-H、Iのpython-情報RET
のpython-情報(第四の上記ツリー内)、さらにはブックマークにファイル名習慣および規則的な見直しの便宜のために、いくつかの任意のノードである。
答えを期待して、この問題を以下の方のために、私はあなたが試してみたいかもしれない別のrst2texinfo実装を見つけます:
別の「回避策は、」Emacsで直接Nikokrockによって示唆されているようにpydoc
を実行することです。
(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")
)
マイケル・エルンストは、Pythonドキュメントの情報フォーマットを維持するために使用ます:
http://www.cs.washington.edu/家庭/ mernst /ソフトウェア/#のpython-情報を
あなたは、更新されたバージョンを生成するために、彼のメイクやhtml2texiスクリプトを使用して試すことができます。どちらも、上記のURLにリンクされています。私は(最後のバージョンは2001年の周りにあった)、それは今どのように動作するかよくわからないんだけど、彼のスクリプトがうまく(「パイソン」のためのgrep)コメントです。
Python ドキュメントは、Sphynx フレームワークを使用して生成されるようになりました。このフレームワークには texinfo 出力形式がありません。現在、次のものがあります。
- HTML
- ラテックス
- プレーンテキスト
おそらく、Latex 出力を使用すると、必要なものが得られるでしょう。テキスト出力では相互参照が失われます。
個人的には、テキスト出力が必要な場合は pydoc を使用することを好みます。Vim では、pydoc を呼び出して、カーソルの下にあるエンティティのドキュメントを含むウィンドウを開くためのショートカットがあります...