33

Python 2.6以降、ドキュメントは新しいreStructuredText形式になっているようで、 TexinfoInfoファイルをすぐに作成するのは簡単ではないようです。

私はEmacsの常習者であり、Infoにインストールされたドキュメントを好みます。

Texinfo形式のPython2.6以降のドキュメントを持っている人はいますか？それらをどのように変換しましたか？または、どこかに維持されたビルドがありますか？

私はw3mまたはhaddocを使用してhtmlドキュメントを表示できることを知っています-私は本当にそれらをInfoに入れたいです。

私はPandocで遊んだことがありますが、いくつかの小さな実験の後、ドキュメント間のリンクをうまく処理できないようです。私の大規模な実験（すべてのドキュメントをまとめて実行し、何が起こるかを確認します）は、まだ2日間で問題が発生しています。始めてから！

2つの良い答え

SOでは両方の回答を受け入れることができないため、以下の2つの回答を強調表示します。

  • @ wilfred-hughes：MELPAからインストールするのが、ビルド前の情報をEmacsに取り込む最も簡単な方法です。
  • @alioth：2009年にこの質問をしたときよりも、自分で作成する方がはるかに簡単なようです。
4

10 に答える 10

24

Jon Waltman http://bitbucket.org/jonwaltman/sphinx-infoは sphinx をフォークし、texinfo ビルダーを作成しました。python ドキュメントをビルドできます (私はまだ実行しています)。もうすぐスフィンクスに統合されるようです。

ダウンロードのクイックリンクは次のとおりです（一時的）：

python doc を texinfo 形式で生成する手順:

Python ソースコードをダウンロードする

sphinx-infoパッケージをダウンロードしてインストールします (virtualenv 内)。

Python ソースから Python/Doc ディレクトリに入ります。

Makefile を編集し、buildターゲットを に置き換え$(PYTHON) tools/sphinx-build.pyてsphinx-buildから、このターゲットを Makefile に追加します。注意してください。echo の前のスペースは 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

于 2010-10-17T08:48:56.940 に答える
3

答えを期待してこの質問に続いている人のために、私はあなたが試してみたいかもしれない別のrst2texinfo実装を見つけました：

http://bitbucket.org/jonwaltman/rst2texinfo/src

于 2010-09-09T03:43:26.790 に答える
2

別の「回避策」は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")
)
于 2009-07-01T11:54:06.697 に答える
1

Python ドキュメントは、Sphynx フレームワークを使用して生成されるようになりました。このフレームワークには texinfo 出力形式がありません。現在、次の機能があります。

  1. HTML
  2. ラテックス
  3. プレーンテキスト

ラテックス出力を使用して、必要なものを取得できるかもしれません。テキスト出力では、相互参照が失われます。

個人的には、テキスト出力が必要な場合は pydoc を使用することを好みます。Vim を使用すると、pydoc を呼び出して、カーソルの下にあるエンティティのドキュメントを含むウィンドウを開くショートカットがあります...

于 2009-06-29T21:34:56.153 に答える