- c - 在位数组中找到第一个零
- linux - Unix 显示有关匹配两种模式之一的文件的信息
- 正则表达式替换多个文件
- linux - 隐藏来自 xtrace 的命令
我使用 autodoc 记录了一些函数。在本地效果很好。当我提交到 GitHub 时,文档是建立在 ReadTheDocs 上的,但是没有我用“automodule”记录的功能。
我在 conf.py 中添加了:
import mock
MOCK_MODULES = ['numpy', 'scipy']
for mod_name in MOCK_MODULES:
sys.modules[mod_name] = mock.Mock()
但这并没有帮助。
这可能与我使用自己的 C 库有关吗?(我有我的 .c 文件,我编译得到 .so)
最佳答案
阅读源文件和日志文件后,我收集了两件事:
为什么要注释掉 conf.py 中的 sys.path.insert(os.path.abspath('../..'))
行?如果您阅读日志,RTD 找不到您的模块。该行将放在正确的路径中。
您也需要将您的 C 库作为模拟模块。
关于python - Autodoc 在本地工作,但不在 ReadTheDocs 上,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/24805538/
我无法上传到 readthedocs我为我的项目准备的文档,我试图了解哪里出了问题。文档在本地构建良好 make html但我无法上传。 GitHub 项目是 ASCIIGenome文档在 docs/
我正在使用Read the Docs首次。我正在为命令行系统编写文档,我的“代码示例”包括 shell 输出的日志。 shell 输出最终看起来像这样 也就是说,该服务(或我对它的使用?)正在尝试将运
我在 ReadTheDocs 上有一个项目。 作为文档生成的一部分,我让 Sphinx 使用 matplotlib 的 plot directive 编译大量图像。显示各种命令的作用。这似乎比 RTD
我正在使用Read the Docs首次。我正在为命令行系统编写文档,我的“代码示例”包括 shell 输出的日志。 shell 输出最终看起来像这样 也就是说,该服务(或我对它的使用?)正在尝试将运
我已遵循 Readthedocs 上的入门指南,并使用 Sphinx 使用 autodoc 在 https://github.com/akdiem/bloodflow 上为我的 Python 包创建文
我正在使用他们的主题在 ReadTheDocs 上使用 Sphinx 创建我的文档。构建过程会生成一个 genindex.html 文件,可以通过以下方式引用: Link to the :ref:`g
我最近添加了 sphinx documentation for blowdrycss阅读文档。 我想覆盖 readthedocs 上的 layout.html 模板.我当前的模板覆盖在 localho
我正在开发一个合理大小的二进制 Python 库,Parselmouth ,这需要一些时间来构建——主要是因为我正在用一个大的代码库包装一个现有的程序。因此,现在我正在尝试设置 API 文档,我遇到了
我正在尝试使用 ReadTheDocs 记录一个 Python 项目。最初,构建过程会在到达以下位置时终止: from osgeo import gdal, osr 我读过 rtd faq并将 moc
我有一个我之前在 ReadTheDocs 上成功构建的包,但现在不再是这样了。我的导入如下: import pandas as pd import numpy as np import scipy i
我的 readthedocs.org 构建刚开始失败......我不确定为什么不特别擅长 Sphynx。我不明白为什么它试图为 docs 目录之外的需求文件构建东西,或者为什么它突然找不到这个版本的
我在 readthedocs 上的自定义域设置有问题。 突然自定义域 (https://docs.joinrpg.ru) 停止使用 SSL_ERROR_NO_CYPHER_OVERLAP。 Vario
我们开始在 readthedocs 站点(比如 http://abc.readthedocs.org )上拥有我们项目的文档。由于各种原因,我们现在使用新域 ( http://abc.io ) 迁移到
我正在尝试将我的 Sphinx 文档与 ReadtheDocs 链接起来。我可以在本地构建文档,但是当我尝试让 ReadtheDocs 自动生成文档时,我收到以下错误: 狮身人面像标准错误 Makin
我有一个基本的 ReadTheDocs 存储库。根据构建页面的建议,我试图使用 .readthedocs.yml配置它: Configure your documentation builds! Ad
我有一个 RST 文件,我不需要任何语法高亮显示。它在文件顶部包含多个文字块和一个 highlight 指令,以尝试禁用语法高亮: .. highlight:: none :: Text that
我有一个 readthedocs sphinx 文档,它使用 nbsphinx 显示 jupyter 笔记本。当我使用 autobuild 在本地构建文档时,我在 jupyter 笔记本的代码单元格中
我有一个私有(private) bitbucket 存储库,其中包含: /docs /docs/source /docs/Makefile /docs/make.bat/ /docs/source/c
我的 docs 文件夹中有一个 assets 文件夹,其中包含与我的项目文档关联的图像和示例输入文件。 图像正确地嵌入了我的文档中,但任何指向示例输入文件(输入到我的项目二进制文件的静态文件)的链接都
我在 readthedocs.org 上管理了一份文档。有没有办法用密码保护或至少让我们的文档仅供部分客户使用? 最佳答案 不幸的是,Read The Docs 上托管的文档无法使用密码保护。 (目前
我是一名优秀的程序员,十分优秀!