问题标签 [python-sphinx]

我喜欢用 Doxygen 创建 C 或 PHP 代码的文档。我有一个即将到来的 Python 项目，我想我记得 Python 没有/* .. */注释，并且还有自己的自我文档工具，这似乎是 Python 的文档方式。

由于我熟悉 Doxygen，如何使用它来生成 Python 文档？有什么特别需要我注意的吗？

我正在开始一个个人项目，我想为我的法语研究员以及说英语的其他人提供文档。

那么我应该如何组织我的目录呢？

要分离什么（我猜来源，一些配置项，如生成导航链接的语言......）？

什么不分开（最多配置项避免重复）？

它是内置在Sphinx中的吗？

我该如何运行它？

我正在使用Sphinx来记录项目。它从reStructuredText生成 LaTeX 文件。

我想给tips和notes设置一个灰色的背景色，所以我在创建了一个graybox环境后自定义了notice环境：

一切正常，除非我在通知环境中放置一个图形环境。在这种情况下，我收到此错误：

LaTeX 错误：不在外部标准模式下

有没有办法为那个通知环境设置灰色背景？

年初时只有少数人推荐使用 Sphinx。

狮身人面像最近发展得相当快。我今天注意到 Sage 已经从使用 LaTex 直接编辑更改为 Sphinx。这在William Stein 4 月 2 日关于 Sage 教程的回答中很明显

本教程不再是乳胶文档。这是一个完全不同的 Sphinx 文档，可以输出 pdf。

这表明我认为 Sphinx 可能处于适合我的水平。

在编写手册/书籍方面，Sphinx 比 LaTex 更好吗？

我有 ReSt (UTF8) 文档，我正在使用sphinx生成 HTML 和乳胶文件。（html转换没有问题）

然后我想将生成的乳胶文件转换为 PDf。目前我正在使用MiKTeX 2.7 的 pdflatex.exe 命令来执行此转换。（转换没有日文字符的源文件会正确生成预期的 pdf）

使用 MiKTeX 包管理器，我安装了 cjk 相关包：cjk-fonts、miktex-cjkutils-bin-2.7 和 cjk。

要调试，我使用以下示例：

在此文件上运行 pdflatex.exe 会产生以下输出：

如何使用 MiKTeX/pdflatex.exe 在生成的 pdf 中正确显示日语？

有没有办法使用 sphinx 自动生成图像/图形标题？

我目前有使用 sphinx 转换为 html 和 (latex)pdf 的 rest-sphinx 文件。

我想要一种简单的方法让用户在生成的 html/pdf 文件中引用特定图像。例如，如果用户在电子邮件中引用文档，“在 'Image 65' 中显示 XXX，但这对我不起作用”。

我尝试使用figure，它似乎允许您将标题应用于图像，但这必须手动添加。（而且由于某种原因，我无法让它与替换一起工作）。

是否有一种我忽略的rest-sphinx方法可以实现这一目标？或者，有没有办法修改/编辑 sphinx 的现有模板以添加此功能？

Sphinx是一个新的 Python 文档工具。它看起来非常漂亮。我想知道的是：

• 这对于记录 C++ 项目有多合适？
• 是否有任何工具可以将现有文档（例如 doxygen）转换为 Sphinx 格式？
• 是否有使用 Sphinx 的 C++ 项目的在线/可下载示例？
• 使用过 Sphinx 的人有什么建议吗？

Sphinx 支持几种输出格式：

• 多个 HTML 文件（带html或dirhtml）
• 乳胶可用于创建.pdf或.ps
• 文本

我怎样才能获得 Microsoft Word 文件中的输出？

使用另一个文档生成器，我设法生成了一个 html 输出文件，然后使用 Word 应用程序将其转换为 Microsoft Word 格式。

不幸的是，我不知道生成 Word 或 HTML 单页格式的方法。