从Python 2.6开始,文档似乎采用了新的reStructuredText格式,并且现在开始构建Texinfo Info文件似乎并不容易.
我是Emacs上瘾者,更喜欢我在Info中安装的文档.
有没有人用Texinfo格式的Python 2.6或更高版本的文档？你是怎么转换它们的？或者,那里有某个维护的构建吗？
我知道我可以使用w3m或haddoc来查看html文档 - 我真的希望它们在Info中.
我和Pandoc一起玩过,但是经过一些小小的实验后,它似乎并不能很好地处理文档之间的链接,我的大型实验 - 在所有文档中运行它以便看到会发生什么 - 仍然在两天内徘徊自从我开始吧!
突出显示以下两个答案,因为SO不允许我接受这两个答案:
@ wilfred-hughes:从MELPA安装是将预构建信息导入Emacs的最快方法
@alioth:自己构建它看起来比我在2009年提出这个问题时容易得多
pygabriel.. 23
Jon Waltman http://bitbucket.org/jonwaltman/sphinx-info已经分叉了sphinx并编写了一个texinfo构建器,它可以构建python文档(我还没有完成它).它似乎很快会合并到狮身人面像中.
以下是下载的快速链接(临时):
http://dl.dropbox.com/u/1276730/python.info
http://dl.dropbox.com/u/1276730/python.texi
以texinfo格式生成python doc的步骤:
下载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
Jon Waltman http://bitbucket.org/jonwaltman/sphinx-info已经分叉了sphinx并编写了一个texinfo构建器,它可以构建python文档(我还没有完成它).它似乎很快会合并到狮身人面像中.
以下是下载的快速链接(临时):
http://dl.dropbox.com/u/1276730/python.info
http://dl.dropbox.com/u/1276730/python.texi
以texinfo格式生成python doc的步骤:
下载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
我已将Python文档打包为texinfo文件.
如果你正在使用带有MELPA的Emacs,你可以简单地安装它M-x package-install python-info.
毫无疑问,自己生成特定Python版本的Python文档会很酷且很有挑战性.只需关注EmacsWiki,或者随意在本地编译它(在Debian Jessy for 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文档了
Cu Ch i python-info RET
python-info是一个文件名(上面树中的第四个),甚至可以为一些任意节点添加书签,以便于习惯性和定期审阅.
京公网安备 11010802040832号 | 京ICP备19059560号-6 