11

我正在使用sphinx为项目生成 html 文档。我广泛使用字段列表

生成 html 时,如果标签的长度最多为 14 个字符,则每个标签/值对将呈现为包含两个单元格的单个表格行。

如果一对标签的长度超过 14 个字符,则标签/值将呈现为两个表格行。

我想将换行限制增加到更大的值(例如 40)。我发现限制是由--field-name-limitdocutils 的选项控制的。但是,我找不到如何通过 sphinx 设置这个值。

docutils.conf在文档根目录中创建了一个文件,其中包含以下内容:

[general]
dump_settings: 1
dump_internals: 1

[html4css1 writer]
field_name_limit: 40

当我运行 sphinx 时读取该文件。由于该[general]部分中的值,打印了设置和内部结构。在打印的值中,field_name_limit打印有 value 40。尽管如此,我描述的包装仍然出现在 html 输出中。

如何设置 的值以field_name_limit获得所需的输出?

4

3 回答 3

3

如果没有异议,Sphinx-1.2 将支持 html writer 的 docutils.conf。 https://bitbucket.org/birkenfeld/sphinx/commits/67682aca

于 2013-07-26T14:51:52.150 回答
0

我认为您的方法不起作用,因为 sphinx 使用自己的 html 编写器。

但是,如果您将样式调整为field_name. 我(曾经)使用了一个自定义的css文件

.field-name {
    white-space: nowrap;
}

或将其设置为固定宽度。

于 2012-11-13T10:39:11.427 回答
0

一种方法是覆盖扩展原始 html 构建器的自定义 sphinx 构建器类中的设置,并self.settings.field_name_limit = 0prepare_writing(self, docnames)函数中设置。也就是说,这有点矫枉过正,除非您已经有一个自定义构建器类......

于 2018-02-14T18:54:20.167 回答