因为Python 2.6,似乎文档是在新的新结构化格式,它似乎并不很容易建立一个Texinfo的信息文件开箱了。
我是一个Emacs的吸毒者和喜欢安装在信息我的文档。
有没有人在的Texinfo格式的Python 2.6或更高版本的文档? 你是如何转换呢? 或者,是否有维护建设地方在那里?
我知道我可以使用的w3m或haddoc查看HTML文档-我真的希望他们的信息。
我已经打了Pandoc但经过几次小实验,它似乎不符合的文件,我的大实验之间的联系,处理好-整个cat'ed在一起的所有文档运行它,看看会发生什么-仍沿着2天隆隆从我开始吧!
两个很好的答案
下面突出的两个答案,因为SO不会让我接受两个答案:
- @威尔弗雷德-休斯: 从MELPA安装是获得最快捷的方式预先建立信息到Emacs
- @alioth: 构建它自己看起来比当我问这个问题在2009年轻松许多
我已经打包了Python文档为Texinfo文件 。
如果你正在使用Emacs与MELPA,你可以简单地安装这个Mx package-install python-info
。
乔恩·沃尔特曼http://bitbucket.org/jonwaltman/sphinx-info已经分叉的狮身人面像和书面的texinfo一个建设者,它可以建立Python文档(我没有完成它)。 它似乎将被合并成很快狮身人面像。
下面是下载量的快速链接(临时):
- http://dl.dropbox.com/u/1276730/python.info
- http://dl.dropbox.com/u/1276730/python.texi
步骤生成的texinfo中的python格式的文档:
下载Python的源代码
下载并安装了狮身人面像,信息包(在virtualenv中)
在Python /文件目录从Python源输入
编辑Makefile文件,到build
目标替代$(PYTHON) tools/sphinx-build.py
与sphinx-build
,那么这个目标添加到makefile文件,注意,呼应前的空格是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
,它应该产生编译/ texinfo的目录texifile。 要生成信息文件运行makeinfo python.texi
毫无疑问这将是冷静和挑战自行生成您的特定Python版本Python文档。 只要按照EmacsWiki ,或随意在本地编译它(在Debian的杰西为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
我得到这个树:
.
├── 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
而现在可以通过审查在Emacs本身 Python文档
铜章和python-RET信息
蟒蛇,信息是一个文件名(在上面的树第四),甚至书签习惯和定期审查方便一些任意节点。
对于那些答案的希望下面的这个问题,我发现了另一个,你可能想尝试rst2texinfo实现:
http://bitbucket.org/jonwaltman/rst2texinfo/src
另一种“变通方法”是执行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")
)
迈克尔·恩斯特用来维持Python文档的信息格式:
http://www.cs.washington.edu/homes/mernst/software/#python-info
您可以尝试使用他的Makefile和html2texi脚本生成的更新版本。 两者都在上述网址链接。 我不知道它有多好现在的工作(上一个版本是2001年左右),但他的剧本有很好的注释(grep命令“蟒蛇”)。
现在Python文档使用斯芬克斯框架生成的。 该框架没有texinfo的输出格式。 目前,它具有:
- HTML
- 胶乳
- 纯文本
也许你可以得到你想要用的是什么乳胶输出。 与文本输出,你会失去交叉参考。
Personnaly我更喜欢使用是pydoc当我想文本输出。 用Vim我有一个shorcut调用是pydoc并打开一个窗口,显示文档我的光标下的实体...