You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们

Sphinx构建的ReadtheDocs中没有包含Docstrings。

可以在 Sphinx 的配置文件中添加一个 autodoc_mock_imports 参数来解决这个问题。该参数可以用于指定需要模拟/排除的模块,以便在生成文档时忽略掉这些模块的 Docstrings。具体步骤如下:

首先,在你的项目根目录下创建一个名为 .readthedocs.yml 的文件,并在其中添加以下内容:

python:
  version: 3.7
  install:
    - requirements: docs/requirements.txt
  system_packages: true

其中,docs/requirements.txt 是你的 Sphinx 项目所需要的依赖文件。

然后,在 Sphinx 的配置文件 conf.py 中,添加以下内容:

autodoc_mock_imports = [
    'numpy',
    'pandas',
    'sklearn'
]

这里以模拟三个常用的库为例,即 numpypandassklearn。你需要根据你的具体应用,增加或减少这个列表中的模块名称。

最后,重新构建你的 Sphinx 项目并上传至 Read the Docs 上,你就能够看到 Docstrings 了。

需要注意的是,这仅适用于你的 Docstrings 内容比较简单的情况下。如果你的 Docstrings 内部依赖了任何其他模块,则需要将这些模块直接导入到 Read the Docs 构建环境中,否则将仍然无法生成 Docstrings。

本文内容通过AI工具匹配关键字智能整合而成,仅供参考,火山引擎不对内容的真实、准确或完整作任何形式的承诺。如有任何问题或意见,您可以通过联系service@volcengine.com进行反馈,火山引擎收到您的反馈后将及时答复和处理。
展开更多
面向开发者的云福利中心,ECS 60元/年,域名1元起,助力开发者快速在云上构建可靠应用

社区干货

Elasticsearch进阶篇@记kibana执行dsl脚本实战过程 | 社区征文

在其各版本系列中提供了丰富的dsl语法-增删改查-这里以[6.x版本系列-6.8.6](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/docs.html)为例。在80%以上的业务场景中作增删改查游刃有余,但应用于... "strings": { "match_mapping_type": "string", "mapping": { "type": "text", "index": true, "copy_to": "full_context", ...

居家办公更要高效 - 自动化办公完美提升摸鱼时间 | 社区征文

doc.pageCount,"页") for pg in range(doc.pageCount): print("\r转换为图片",pg+1,"/",doc.pageCount,end="") page = doc[pg] rotate = int(0) # 每个尺寸的缩放系数为8,这将为我们生成分辨率提高64倍的... 其实这里包含了合并多张图片到 pdf 文档中```pythonimport comtypes.clientimport osdef init_powerpoint(): powerpoint = comtypes.client.CreateObject("Powerpoint.Application") powerpoint.Visi...

特惠活动

热门爆款云服务器

100%性能独享,更高内存性能更佳,学习测试、web前端、企业应用首选,每日花费低至0.55元
60.00/1212.00/年
立即购买

域名注册服务

cn/top/com等热门域名,首年低至1元,邮箱建站必选
1.00/首年起32.00/首年起
立即购买

DCDN国内流量包100G

同时抵扣CDN与DCDN两种流量消耗,加速分发更实惠
2.00/20.00/年
立即购买

Sphinx构建的ReadtheDocs中没有包含Docstrings。 -优选内容

通过 Kafka 消费火山引擎 Proto 格式的订阅数据
包含一个 Demo 文件。 按需修改 Demo 文件,具体代码如下所示。 参数 说明 示例值 GROUP 消费组名称。 285fef6b91754d0bbaab32e4976c****:test_dtssdk USER Kafka 用户名。 test_user PASSWORD Kafka 用户密码。 ... "strings" "sync" "github.com/Shopify/sarama" proto "github.com/volcengine/volc-sdk-golang/example/dts/data-subscription-demo/proto" protobuf "google.golang.org/protobuf/proto" ) typ...
Elasticsearch进阶篇@记kibana执行dsl脚本实战过程 | 社区征文
在其各版本系列中提供了丰富的dsl语法-增删改查-这里以[6.x版本系列-6.8.6](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/docs.html)为例。在80%以上的业务场景中作增删改查游刃有余,但应用于... "strings": { "match_mapping_type": "string", "mapping": { "type": "text", "index": true, "copy_to": "full_context", ...
UpdateDomain-更新云 WAF 实例的防护网站信息
更新已添加的域名防护信息,包括接入能力、回源配置等参数。 注意事项更新防护网站信息时的请求参数为网站的全量参数,建议您先查询对应网站的详情,可参考ListDomain-查询云 WAF 实例防护网站信息。 域名、接入协议、... Protocols Array of Strings 否 ["HTTP"] 接入协议类型,不支持更新。 HTTP HTTPS ProtocolPorts ProtocolPorts object 否 - 接入端口信息,不支持更新。 EnableHTTP2 Integer 否 0 是否开启 HTTP 2...
CreateDomain-通过 CNAME 方式接入
Protocols Array of Strings 否 ["HTTP"] 接入协议类型,支持单选和多选。 HTTP HTTPS 说明 当EnableHTTP2=1时,需勾选HTTPS。 当ProtocolFollow=1时,需同时勾选HTTP和HTTPS。 ProtocolPorts ProtocolPorts... ProxyReadTimeOut Integer 否 60 WAF 从后端服务器读取响应的超时时间,支持 0-900 秒。默认为 60 秒。 ProxyKeepAlive Integer 否 100 WAF 回源长连接可复用个数,支持 60-1000 个,默认为 100 个。 Pro...

Sphinx构建的ReadtheDocs中没有包含Docstrings。 -相关内容

居家办公更要高效 - 自动化办公完美提升摸鱼时间 | 社区征文

doc.pageCount,"页") for pg in range(doc.pageCount): print("\r转换为图片",pg+1,"/",doc.pageCount,end="") page = doc[pg] rotate = int(0) # 每个尺寸的缩放系数为8,这将为我们生成分辨率提高64倍的... 其实这里包含了合并多张图片到 pdf 文档中```pythonimport comtypes.clientimport osdef init_powerpoint(): powerpoint = comtypes.client.CreateObject("Powerpoint.Application") powerpoint.Visi...

ListDomain-查询云 WAF 实例防护网站信息

SSLCiphers Array of Strings ["ECDHE-ECDSA-AES128-SHA","ECDHE-ECDSA-AES256-SHA"] TLS 加密算法套件。 ClientMaxBodySize Integer 10000 客户端请求 body 最大值。 KeepAliveTimeOut Integer 100 长连接保持时间。 KeepAliveRequest Integer 100 长连接复用个数。 ProxyConnectTimeOu Integer 100 WAF 和后端服务器的建连超时时间。 ProxyReadTimeOut Integer 120 WAF 从后端服务器读取响应的超时时...

对接指南

Access Key 包括 Access Key ID(简称为 AK) 和 Access Key Secret(简称为 SK),其中,Access Key ID 用于标识用户,Access Key Secret 用于验证用户的密钥,请您妥善保管。AK/SK 密钥获取方式如下,更多详情请参考 Acce... Go package mainimport ( "bytes" "fmt" "net/http" "net/url" "strings" "io/ioutil" "github.com/volcengine/volc-sdk-golang/base")const ( testAk ...

热门爆款云服务器

100%性能独享,更高内存性能更佳,学习测试、web前端、企业应用首选,每日花费低至0.55元
60.00/1212.00/年
立即购买

域名注册服务

cn/top/com等热门域名,首年低至1元,邮箱建站必选
1.00/首年起32.00/首年起
立即购买

DCDN国内流量包100G

同时抵扣CDN与DCDN两种流量消耗,加速分发更实惠
2.00/20.00/年
立即购买

对接指南

Access Key 包括 Access Key ID(简称为 AK) 和 Access Key Secret(简称为 SK),其中,Access Key ID 用于标识用户,Access Key Secret 用于验证用户的密钥,请您妥善保管。AK/SK 密钥获取方式如下,更多详情请参考 Acce... Go package mainimport ( "bytes" "fmt" "net/http" "net/url" "strings" "io/ioutil" "github.com/volcengine/volc-sdk-golang/base")const ( testAk ...

快速入门(Go SDK)

上传到指定 example_dir 目录下的 example.txt body := strings.NewReader("Hello TOS") output, err := client.PutObjectV2(ctx, &tos.PutObjectV2Input{ PutObjectBasicInput: tos.PutObjectBasicInput{ Bucket: bucketName, Key: objectKey, }, Content: body, }) // 判断错误if err != nil { // 判断服务端错误 if serverErr, ok := err.(*tos.TosServerError); ok { f...

使用 STS 临时 AK/SK+Token 访问火山引擎 TOS

选择步骤二中创建的角色,然后单击确定。 步骤六:请求 AssumeRole 接口获取临时访问凭证注意 临时密钥的实际权限是角色具有的权限和 IAM 策略的交集。 如果不指定 IAM 策略,则临时密钥拥有指定角色的预关联策略的权限。 如果角色没有预关联策略,即使指定了 IAM 策略,实际权限也为无。 火山引擎 API 请求的签名算法,和 AWS V4 基本一致(部分 Header 不同),详情请参见签名机制。您可以调用 STS 服务接口 AssumeRole 来获取临时访问...

上传回调(Go SDK)

示例代码 普通上传实现上传回调Go package mainimport ( "context" "encoding/base64" "fmt" "os" "strings" "github.com/volcengine/ve-tos-golang-sdk/v2/tos")func checkErr(err error) { ... Reader("object content") output, err := client.PutObjectV2(context.Background(), &tos.PutObjectV2Input{ PutObjectBasicInput: tos.PutObjectBasicInput{ Bucket: bucketName, ...

使用 ETag 验证简单上传场景下 TOS 对象的完整性

那么即使数据没有变化,校验和值也会发生变化。 二、代码实现 package mainimport ( "context" "crypto/md5" "encoding/hex" "fmt" "github.com/volcengine/ve-tos-golang-sdk/v2/tos" "io/ioutil" "os" "strings")... err := ioutil.ReadAll(localfile) localMD5Values := GetFileMd5Hash(all) // 上传对象并获取返回的Etag var ( accessKey = "xxxxx" secretKey = "xxxxx" endpoint = "tos-cn-beijing.volces.com" region ...

对接指南

需要先完成以下操作。 前提条件 已通过 注册账号及开通服务 页面操作完成注册账号及开通服务。 AK/SK 密钥获取 在调用知识库的各个能力之前,确保您已生成访问密钥 Access Key。Access Key 包括 Access Key ID(简称... Go package mainimport ( "bytes" "fmt" "net/http" "net/url" "strings" "io/ioutil" "github.com/volcengine/volc-sdk-golang/base")const ( testAk ...

特惠活动

热门爆款云服务器

100%性能独享,更高内存性能更佳,学习测试、web前端、企业应用首选,每日花费低至0.55元
60.00/1212.00/年
立即购买

域名注册服务

cn/top/com等热门域名,首年低至1元,邮箱建站必选
1.00/首年起32.00/首年起
立即购买

DCDN国内流量包100G

同时抵扣CDN与DCDN两种流量消耗,加速分发更实惠
2.00/20.00/年
立即购买

产品体验

体验中心

云服务器特惠

云服务器
云服务器ECS新人特惠
立即抢购

白皮书

一图详解大模型
浓缩大模型架构,厘清生产和应用链路关系
立即获取

最新活动

爆款1核2G共享型服务器

首年60元,每月仅需5元,限量秒杀
立即抢购

火山引擎增长体验专区

丰富能力激励企业快速增长
查看详情

数据智能VeDI

易用的高性能大数据产品家族
了解详情

一键开启云上增长新空间

立即咨询