为啥很多Python第三方库的文档都是文本格式的，怎么用？ [关闭]

Posted 2023-02-23

【中文标题】为啥很多Python第三方库的文档都是文本格式的，怎么用？ [关闭]

【英文标题】：Why the many Python third-party library documentations are txt format,How to use them? [closed]为什么很多Python第三方库的文档都是文本格式的，怎么用？ [关闭]

【发布时间】：2012-12-20 22:03:57

【问题描述】：

就像 django 文档和 docutils 文档一样。

我是一名 Java 程序员，jar doc 都是 html。 所以我不知道如何使用python txt doc

【问题讨论】：

什么？ docs.djangoproject.com/en/1.4 充满了 HTML Django 文档。

我认为他的意思是如何将 rst 格式转换为 html，如 django 和 docutils 在线文档，请转到 sphinx：sphinx-doc.org 它是一个可以让您做到这一点的工具。

不知道有多少人收藏了这个页面来证明Java程序员不知道如何阅读文本文件……

Java 程序员根本不看文档...

@CRUSADER：当然可以。但是首先他们必须构建一个 DocReaderAdapterFactoryFactory 来构建 DocReaderAdapterFactory 来构建 IDocReaderAdapter 来适配 IDocReader 接口来为他们读取 IDocumentation。即使您使用的是 emacs 或 NetBeans，它也会将其置于 Eclipse 窗口中。

【参考方案1】：

现在大多数文档都是使用reStructuredText 编写的。 Sphinx Python documentation generator 可用于转换那些 文档转换为 PDF、HTML、LaTeX、EPUB 和其他格式。

packages.python.org 或 readthedocs.org 上的大多数 Python 文档 实际上是从 reStructuredText 和 Sphinx 生成的。

所以你的整体印象是错误的。

【讨论】：

谁反对这个？它解释了如何将文本（rst）文档转换为 HTML。你还需要什么？

@abarnert 它得到了我的支持（如果它很糟糕 - 我可能不会（像你自己一样）进行快速编辑） - 我也看不出反对的理由.. .

@CRUSADER 谢谢，我的印象是错误的，我误以为是普通文字

【参考方案2】：

我怀疑这部分是为了鼓励用户参考在线文档——在 Django 的案例中，这是明确推荐的。

但是，可以根据以下链接生成 Django 文档的本地 HTML 副本：https://docs.djangoproject.com/en/dev/intro/whatsnext/?from=olddocs#as-html-本地

由于 Python 标准库文档也是使用 Sphinx 生成的，因此也应该可以生成本地 HTML 版本。