You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何让Sphinx的ReadTheDocs主题在移动端优雅展示函数参数?

解决Sphinx ReadTheDocs主题窄屏参数列表溢出问题

可以通过自定义CSS精准定位函数/方法相关的定义列表,强制标题单独成行并优化布局,完全满足你的需求。以下是具体实现方案:

自定义CSS代码

创建自定义样式文件(比如_static/css/custom.css),添加以下代码:

/* 仅针对Python函数/方法/类的参数、返回值等定义列表 */
.rst-content div[class^="py-"] dl.field-list {
    display: block;
    margin-bottom: 1.5em; /* 与其他内容保持一致的垂直间距 */
}

/* 让Parameters/Raises/Returns等标题单独成行 */
.rst-content div[class^="py-"] dl.field-list dt {
    display: block;
    font-weight: bold;
    margin-bottom: 0.5em; /* 标题与下方内容的间距 */
    color: #2980b9; /* 可选:匹配RTD主题链接色,突出标题 */
}

/* 调整参数描述的缩进与间距 */
.rst-content div[class^="py-"] dl.field-list dd {
    margin-left: 1.5em; /* 自定义缩进大小,按需调整 */
    margin-bottom: 0.8em; /* 每个参数项之间的垂直间距 */
}

/* 移除最后一个参数项的底部间距,避免多余留白 */
.rst-content div[class^="py-"] dl.field-list dd:last-child {
    margin-bottom: 0;
}

代码说明

  1. 精准定位元素:使用div[class^="py-"]选择器,只匹配Sphinx生成的Python类、方法、函数的容器(对应py-class/py-method/py-function类),不会影响页面其他<dl>元素。
  2. 强制垂直布局:将dl.field-list设为display: block,打破默认横向布局,让标题和内容垂直排列,从根本解决窄屏溢出问题。
  3. 优化排版细节:通过调整标题加粗、内容缩进、垂直间距,保证宽屏环境下的可读性与美观度。

应用自定义CSS

在Sphinx项目的conf.py中添加以下配置,让编译后的文档加载自定义样式:

html_css_files = [
    'css/custom.css',
]

内容的提问来源于stack exchange,提问作者Arthur Tacca

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.06.17 01:26:10