You write your documentation using a plain text markup format, reStructuredText.
Sphinx can create HTML, Windows HTML help and PDF (via Latex).
I have created end-user documentation for two projects using Sphinx, and have also used it to document a couple of Python packages (Sphinx has a lot of features around extracting documentation from Python modules, it was originally created to write the Python documentation).
It is very easy to get started, and you get professional-looking documentation with a minimal effort.
If you are used to the WYSIWYG way of text editing, using a plain-text markup format might take some getting used to. But I believe it will be worth the effort.
I also have some experience with DocBook (one of the end-user documentation projects mentioned was a DocBook-to-Sphinx migration). I prefer Sphinx over Docbook: Plain text is more pleasant to work with than XML, Sphinx has a simpler toolchain.
发布评论
评论（5）
如果您尝试构建基于 .chm 的帮助，请尝试 chm-build< /a>
If you are trying to build .chm based help, try chm-build
看看这个免费帮助创作工具列表，那里肯定会有一些有用的东西。
Check out this list of free help authoring tools, bound to be something useful there.
请记住：根据您想要执行的操作，您可以使用 doxygen (www.doxygen.org) 或 http://www.vizacc.com/。
Just remembered: depending on what you want to do, you can use doxygen (www.doxygen.org) or the free help tool from http://www.vizacc.com/.
我喜欢Sphinx。
您可以使用纯文本标记格式 reStructuredText 编写文档。
Sphinx 可以创建 HTML、Windows HTML 帮助和 PDF（通过 Latex）。
我使用 Sphinx 为两个项目创建了最终用户文档，并且还用它来记录几个 Python 包（Sphinx 有很多关于从 Python 模块中提取文档的功能，它最初是为了编写 Python 文档而创建的）。
它非常容易上手，并且您可以轻松地获得具有专业外观的文档。
如果您习惯于所见即所得的文本编辑方式，那么使用纯文本标记格式可能需要一些时间来适应。 但我相信这是值得的。
我也有一些使用 DocBook 的经验（提到的最终用户文档项目之一是 DocBook 到 Sphinx 的迁移）。 与 Docbook 相比，我更喜欢 Sphinx：纯文本比 XML 更适合使用，Sphinx 具有更简单的工具链。
另请参阅：
I like Sphinx.
You write your documentation using a plain text markup format, reStructuredText.
Sphinx can create HTML, Windows HTML help and PDF (via Latex).
I have created end-user documentation for two projects using Sphinx, and have also used it to document a couple of Python packages (Sphinx has a lot of features around extracting documentation from Python modules, it was originally created to write the Python documentation).
It is very easy to get started, and you get professional-looking documentation with a minimal effort.
If you are used to the WYSIWYG way of text editing, using a plain-text markup format might take some getting used to. But I believe it will be worth the effort.
I also have some experience with DocBook (one of the end-user documentation projects mentioned was a DocBook-to-Sphinx migration). I prefer Sphinx over Docbook: Plain text is more pleasant to work with than XML, Sphinx has a simpler toolchain.
See also:
您是否也想制作 CHM 或其他输出格式？
看看 DocBook。 您可以（从一个源文件）制作 pdf、html 和 chm - 以及其他一些文件。 我过去用过它，但使用起来不太容易或不方便。 如果您只想输出 chm（并且需要使用免费解决方案），请查看是否可以使用 htmlhelp 研讨会（http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc& ;displaylang=en）。
Are you trying to make just CHM or other output formats too?
Take a look at DocBook. You can make (from one source file) pdf, html and chm - and some others, too. I've used it in the past but it's not very easy or convenient to use. If you only want to output chm (and need to use a free solution), see if you can get away with using the htmlhelp workshop (http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en).