问题标签 [python-sphinx]

我正在使用狮身人面像。我想把它模板化。所以在阅读了文档之后，我正在尝试的是，在我的 conf.py 中，

我放了一条线，

我创建了一个文件

但这不会覆盖 sphinx 提供的默认模板。我还应该做什么，这个模板需要去哪里？

编辑：

评论中的目录结构：

我正在使用Sphinx和autodoc 扩展为我的 Python 模块生成 API 文档。虽然我可以看到如何很好地记录特定参数，但我找不到如何记录**kwargs参数的示例。

有没有人有一个很好的例子来说明记录这些的清晰方法？

I am using Sphinx for documenting my python project. I have the autodoc extension enabled and have the following in my docs.

The problem is, it only documents the non-private methods in the class. How do I include the private methods too?

我试图设置 django 。我确实有 Django-1.1-alpha-1。我试图使用 make 实用程序制作位于 Django-1.1-alpha-1/doc 的文档。

但我收到一些错误说

有谁知道如何解决这个问题并制作一个html文档

谢谢J

我正在使用 Sphinx 记录将部署在不同服务器中的 Web 服务。该文档充满了供用户单击的 URL 示例，它们应该可以正常工作。我的问题是主机、端口和部署根目录会有所不同，并且必须为每次部署重新生成文档。

我尝试定义这样的替换：

但是生成的 HTML 不是我想要的（在生成的链接中不包含“/path”）：

有人知道如何解决这个问题吗？

我已经安装了Sphinx来记录我正在处理的一些 Python 模块和类。虽然标记语言看起来很不错，但我还没有设法自动记录 Python 代码。

基本上，我有以下 Python 模块：

并在其中调用了一个类Seg。我想在生成的 Sphinx 文档中显示类和模块的文档字符串，并向其中添加更多格式化文本。

我的index.rst样子是这样的：

和chapter1.rst：

但是Seg只是以粗体打印，并且没有链接到该类的自动生成的文档。

尝试以下方法也无济于事：

编辑：将 SegLib 更改为段（感谢 iElectric！），并将 chapter1.rst 更改为：

尽管如此，不能让 Sphinx 直接记录类中的函数，或者更好地 - 自动将类中的所有函数添加到文档中。试过：

并得到：

任何想法如何使用简短命令自动记录函数和类？

这是先前关于 Sphinx的问题的通用版本。

有没有办法递归地自动记录包含类和函数的模块或包？

我认为为每个函数添加autofunctionor指令是愚蠢的；automodule必须有一种方法可以使该过程自动化，否则我根本看不到使用 Sphinx 的意义。

澄清： 而不是：

这需要我手动剪切和粘贴所有方法名称并相应地更新文档，我想要一个类似的命令：

Sphinx 有一个称为automethod从方法的文档字符串中提取文档并将其嵌入到文档中的功能。但它不仅嵌入了文档字符串，还嵌入了方法签名（名称+参数）。如何仅嵌入文档字符串（不包括方法签名）？

参考：http ://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

这个问题今天更难了，因为我今天没有使用 Sphinx 主页上的搜索功能。

我有一组模块，我想从文档字符串中记录下来。但是，这些不是纯 Python 脚本。它们不会按原样编译，因为它们是从在执行范围内创建新变量的 C# 应用程序运行的。

对于 Python 编译器，看起来我有一个未定义的方法（从技术上讲，我会这样做，直到 C# 创建 IronPython 脚本引擎并创建该方法）。

当我运行时：

我得到：

如何让 Sphinx 忽略编译错误并只生成我的文档？

编辑：

如果有人知道 Sphinx 的替代品（如 Epydoc）是否不必编译 Python 脚本来获取函数签名和文档字符串，那也会很有帮助。Sphinx 是最好看的文档生成器，但如果必须，我会放弃它。

我刚刚记录了我的大量代码并学习了如何使用 sphinx 来生成文档。我想将它包含到我的 GitHub 项目页面中，但我不知道如何去做。有谁知道现有的教程或简单的步骤？