问题标签 [python-sphinx]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
8 回答
13833 浏览

python - 使用 Sphinx 编写个人网站和博客

Sphinx是一个 Python 库,用于从一组ReST格式的文本文件生成漂亮的文档。

我想知道是否有人编写了 Sphinx 插件来使其生成个人网站和博客

特别是对于博客,需要一种方法来自动按时间顺序列出帖子并生成 RSS 提要。需要编写一个 Sphinx 插件来生成这种特殊的页面/xml。

有没有人试过这个?

0 投票
3 回答
2173 浏览

python - Sphinx(文档工具):在输出中设置标签宽度

如何在 Pygments 突出显示的 Sphinx 代码片段的 HTML 输出中设置选项卡宽度?默认情况下它是烦人的 8,但我想要 4。在 Sphinx conf.py 中没有找到有关此设置的信息。

0 投票
1 回答
3397 浏览

python - 我的笔记的狮身人面像来源的位置 - 警告:文档不包含在任何目录树中

你如何修复狮身人面像在底部的警告?

我正在尝试将我的 Python 笔记放在 Sphinx 中。我将笔记放在与index.rst相同目录级别的单独文件中。

构建 HTML 后收到以下警告

警告

构建时的完整信息

0 投票
3 回答
3293 浏览

python-sphinx - Sphinx/reStructuredText 中表格的编辑器?

我正在考虑使用 Sphinx / reStructuredText 作为文档,它看起来很有希望,除了表格看起来很痛苦。有没有可以帮忙的编辑器?

0 投票
5 回答
11013 浏览

php - 使用 Sphinx 生成 PHP 代码文档?

Sphinx 是一个 Python 库,用于从一组 ReST 格式的文本文件生成漂亮的文档。不是用于全文搜索的工具

我也完全了解 doxygen / phpdoc 工具。我想弄清楚是否有一种方法可以使用 Sphinx 来记录 PHP 项目?甚至任何其他非 Python 语言?

https://www.sphinx-doc.org/en/master/

0 投票
3 回答
2086 浏览

python - 强制解压某些 egg 目录

我有一个我自己构建的 PyQt 应用程序的 egg 分发版,它包含 sphinx 生成的文档。当我从应用程序调用帮助文件时,它会在 QtWebKit.QWebView 窗口中打开 sphinx index.html。显然,只有 index.html 文件从 egg 中提取到操作系统的 egg 目录中(例如 Windows 下的 [..]\Application Data\Python-Eggs\)。

这会导致 css 损坏、图像损坏和链接损坏,因为这些其他文件似乎没有被解包;它们存在于 egg 文件中,但不在 egg-directory 中。

我在这里错过了什么吗?有没有办法立即强制解压缩所有 html、css、图像文件?

0 投票
2 回答
679 浏览

python - 在 Python Sphinx 文档中记录模块/类/函数体

Sphinx 文档有没有办法通过 autodoc 功能输出函数或类主体(代码本身)?我使用 autodoc 取得了很大的成功。除了文档字符串被拉入文档之外,我还想要一个链接来单击每个函数,它将向您显示源代码......这可能吗?

这就是我的大部分文档现在的样子:

0 投票
1 回答
321 浏览

ant - 有人从 Ant 运行 Sphinx 吗?

我将Sphinx用于一些软件文档,因为它似乎工作得很好……但我的项目是一个 Java 项目,我想从 Ant 脚本运行 Sphinx。

有没有人编写过自定义 Ant 任务来调用 Sphinx?

0 投票
2 回答
848 浏览

php - PHP 的外部文档,没有 DocBook

我需要一个 PHP 项目的文档系统,并且我希望它能够将外部文档(用例、项目范围等)与从代码注释生成的文档集成。似乎 phpDocumentor 具有完全正确的功能集,但外部文档必须用 DocBook 编写,这对我们的团队来说太复杂了。

如果它在 python 中,sphinx 将非常适合这项工作(ReST 绝对比 docbook 简单)。有什么方法可以将外部 ReST 文档与从 phpdoc 中提取的文档集成在一起?我是否应该将外部文档分开(例如,将 ReST 用于外部,将 phpdoc 用于内部)?或者您对管理外部文档有更好的建议吗?

0 投票
1 回答
925 浏览

python - Sphinx 0.6.3:找不到语言模块

当我尝试使用 sphinx-quickstart 生成的 make.bat 命令时收到以下错误消息:

制作html

错误:找不到语言模块。您是否正确安装了 Sphinx 及其依赖项?

我尝试运行 sphinx-build 命令并收到相同的错误。

我在 Windows Vista 上使用 Python 2.6.4。我已经安装了 setuptools-0.6c11.win32-py2.6,并使用 easy_install 安装了 Sphinx 0.6.3。

似乎init .py 在尝试导入 cmdline 时失败(我 grep 了错误消息的一部分,而init .py 是唯一出现的文件),因为错误出现在try导入 cmdline 的块中。

我看不到“语言”会作为参数传递到哪里,所以我对错误消息感到困惑。我一直在寻找解决方案,但一无所获。