腾讯云
开发者社区
文档
建议反馈
控制台
首页
学习
活动
专区
工具
TVP
最新优惠活动
文章/答案/技术大牛
搜索
搜索
关闭
发布
登录/注册
精选内容/技术社群/优惠产品,
尽在小程序
立即前往
文章
问答
(9999+)
视频
沙龙
1
回答
Sphinx
文档
使用
autodoc
在
本地
成功
构建
,
但是
当我
尝试
在
readthedocs
上
构建
它
时
,
所有
页面
都
变成
空
的
。
、
、
、
我试着把我做过
的
代码
的
文档
放在
readthedocs
上
,
但是
所有
的
页面
都
变成
了空白。我已经
尝试
了一整天,我已经看了/读了几十个教程,但都没有
成功
的
迹象。
当我
在
本地
执行时,它可以正常
构建
。目录
的
组织方式如下: /root: /docs,module
浏览 82
提问于2021-11-05
得票数 0
1
回答
本地
sphinx
从docstring生成
autodoc
成员,
readthedocs
不生成
、
、
、
我
在
github有一个。包没有外部依赖项,
所有
源
都
包含在一个__init__.py文件中。
在
." 当
使用
make html
在
本地
生成
文档
时
,这个过程进行得很好:当单击index.html
页面
中
的
nix_shell_utils链接
时
,我进入了nix_shell_uti
浏览 21
提问于2022-11-06
得票数 1
回答已采纳
1
回答
有没有办法
在
Sphinx
中预编译由
autodoc
生成
的
.rst文件
、
、
、
我有一个项目,我
使用
sphinx
.ext.apidoc为该项目
构建
了一组.rst文件,可以从项目的
文档
字符串中提取
文档
。---------- :members: :show-inheritance: make html
在
我
的
计算机上正确地
构建
了
文档
,
但是
要求我编辑conf.py文件以将我
的
项目添加到
浏览 0
提问于2015-03-11
得票数 1
2
回答
genindex和modindex页脚链接在
readthedocs
.io中不起作用
、
、
、
我有一个Python项目,
使用
Sphinx
作为
文档
。我正在
readthedocs
.io服务
上
远程
构建
文档
。我
使用
了
sphinx
-quickstart,
它
生成了一个具有以下链接
的
index.rst文件:~~~~~~~~~~~~~~~~~~ * :ref:`modindex`
当我</e
浏览 2
提问于2020-11-05
得票数 0
回答已采纳
2
回答
阅读不
使用
自动模式
的
文档
、
、
、
我为我
的
项目编写了一些
文档
(
在
Python中),并在
本地
计算机上用
Sphinx
测试了
所有
东西--一切正常工作,
所有
导入工作
都
正确,等等。因此,我
在
Read (Python 3、numpydoc和我
的
库)
上
设置了一个自定义环境,将docs目录(和docs/source子目录)添加到我
的
Github中,然后读取
文档
的
构建
就
浏览 2
提问于2014-07-29
得票数 11
1
回答
Sphinx
无法导入模块依赖项
、
、
、
、
编写awscli-bastion
的
python工具具有由cookiecutter
构建
的
以下目录结构。Optionally set the version of Python and requirements required to build your docs version: 3.7 当在
本地
构建
sphinx
时
,
所有
模块函数都是自动记录
的
。
当我
在
readthedoc.io
浏览 34
提问于2019-09-17
得票数 3
1
回答
ReadTheDocs
模块中不解析
文档
字符串(狮身人面像)
、
我已经开源了我
的
一些代码,
但是
文档
不会在
ReadTheDocs
上
正确
构建
,尽管
sphinx
-quickstart和make html
在
本地
创建
的
Makefile就像预期
的
那样工作。我读过关于可能
使用
RTD高级设置
在
virtualenv中
构建
模块
的
文章,但这不起作用,因为我将due作为一个需求,
构建
失败是因为没有
浏览 3
提问于2016-04-17
得票数 6
1
回答
ReadTheDocs
和
autodoc
在
构建
过程中找不到我
的
包
、
、
我一直试图
在
readthedocs
上
为我
的
首个python包QutiePy
构建
文档
。
构建
文档
在
本地
运行良好,
但是
当我
试图
构建
readthedocs
时
,
autodoc
无法填充我
的
部分,并给出以下警告: WARNING:
autodoc
: failed to import cla
浏览 3
提问于2021-01-24
得票数 1
回答已采纳
1
回答
Readthedocs
使用
过时
的
代码版本
构建
。
、
、
当在读
文档
中运行
autodoc
时
,它在我
的
项目中出现以下错误时失败:我已经了解到RTDF中没有gfortran,所以我想
尝试
避免在运行
Sphinx
时
导致错误
的
命令,比如正如中所建议
浏览 1
提问于2018-01-29
得票数 0
回答已采纳
1
回答
如何设置读取
文档
以使
Sphinx
autodoc
选项工作?
、
、
、
、
我
的
项目不是用
autodoc
来建造
的
。我遇到了。
但是
,一些依赖项包括c代码,它不会在
构建
Docs服务器
上
执行。所以我在这个中读到了这个方法。这与堆栈溢出问题“如何模拟从x导入-工作”有关。
在
Read
上
管理
页面
的高级设置部分,有一个选项可以
使用
virtualenv,我检查了
它
,然后请求指向requirements.txt
的
项目根目录
的
路径。项目目录
的</em
浏览 2
提问于2014-02-16
得票数 4
回答已采纳
1
回答
autodoc
指令
在
本地
有效,但在
readthedocs
上不起作用
、
、
、
我
的
回购位于github
上
:
ReadTheDocs
没有失败,
但是
生成
的
文档
(托管在这里:)没有显示应该由..
autodoc
::命令生成
的
文档
字符串。
但是
,它在
本地
运行良好,并在我打开build/html/index.html文件
时
显示
文档
。
在
ReadTheDocs</
浏览 10
提问于2017-07-09
得票数 3
回答已采纳
1
回答
如何通过
readthedocs
构建
中
的
脚本修改用斯芬克斯
构建
的
文档
、
我正在
尝试
运行一个脚本来修改由Read托管
的
sphinx
构建
的
文档
(因为有些链接没有得到正确
的
处理)。
当我
试图
在
本地
构建
脚本
时
,脚本可以工作,但在读取
文档
生成
时
失败,或者更改不会传播到网站。我试图运行
的
脚本非常简单,
它
替换了一些没有被
sphinx
标记表正确转换
的
html链接:
浏览 11
提问于2022-08-23
得票数 1
1
回答
当依赖关系需要身份验证
时
,
Readthedocs
构建
会忽略子模块(例如: python包需要Google引擎
时
)
、
、
、
、
使用
sphinx
自动生成
文档
(用于
在
readthedocs
上进行最终存储)
在
本地
工作,
但是
导入ee
的
所有
子模块都不
构建
在
readthedocs
.com
上
。问题:是否有办法为
readthedocs
保存我自己
的
身份验证令牌,以便我
的
文档
能够为我
的
所有
子模块正确<
浏览 8
提问于2022-05-31
得票数 0
回答已采纳
1
回答
狮身人面像
文档
(
autodoc
)上传到Github后不起作用
、
、
我已经为我
的
包裹建立了狮身人面像
的
文档
。当测试
本地
主机时,
它
工作得很好。
但是
,
在
将其上传到Github并在
readthedocs
.org
上
构建
文档
之后,
文档
页面
就无法工作,
它
使用
的
是
autodoc
。这是指向Github存储库
的
链接。 这是指向
文档
的
浏览 3
提问于2022-05-24
得票数 2
回答已采纳
2
回答
Python狮身人面像自动
文档
没有
在
readthedocs
上
呈现
、
、
、
我有一个托管
在
Github
上
的
Python包,名为。我已经
使用
狮身人面像和.rst文件准备了我
的
文档
。这些文件托管
在
GitHub
上
。我能够
成功
地
在
本地
运行make html并获得所需
的
输出。例如,下面是参考指南第一部分在
本地
呈现时
的
样子:
但是
,当
文档
在
readthedoc
浏览 4
提问于2020-12-29
得票数 8
回答已采纳
1
回答
在
readthedocs
.org
上
构建
狮身人面像
文档
时
,将
所有
警告视为错误
、
、
我们
的
开源Python项目()
使用
readthedocs
.org来
使用
Sphinx
自动
构建
每个拉请求
的
文档
。如果狮身人面像发出任何警告,我们希望
文档
构建
失败,因为这些警告通常表明
文档
的
某些部分没有正确
构建
。然而,
在
我
的
本地
计算机上,我可以
使用
make html SPHINXOPTS=&quo
浏览 2
提问于2020-04-24
得票数 2
2
回答
如何
使用
ReadTheDocs
或狮身人面像托管私有
文档
、
花了一整天
的
时间试图找出“最常用”
的
方法。我想要实现
的
是类似于
readthedocs
.org
的
东西,
但是
是针对私人客户(和专有项目)。几乎
所有
的FAQ、博客文章、howtos等都在描述如何
使用
GitHub
页面
,或者用
readthedocs
.org (.com)来保存(发布)
文档
。我
尝试
在
本地
使用
Sphinx
(
浏览 3
提问于2016-06-30
得票数 30
4
回答
由于丢失了pandoc,
构建
文档
失败
、
、
、
问题所在 当单击
readthedocs
.io web界面上
的
" build“
时
,我很难获得要
成功
构建
的
文档
,
但是
它在我
的
本地
机器
上
构建
得很好。我还试图让它从源代码中
构建
,
在
我
的
pandoc文件中用git+git://github.com/jgm/pandoc#egg=pandoc
浏览 5
提问于2020-06-15
得票数 14
2
回答
Docstring不包括
在
Read the Docs
Sphinx
构建
中
、
、
、
我
构建
了一个
Sphinx
文档
,该
构建
在
本地
运行良好。我
的
文档
字符串如下所示。 ?
在
迁移到readthedoc.io
时
,我
在
docs/requirement.txt下添加了一个特定
的
需求文件,该文件是:
sphinx
==3.5.4sphinxcontrib-applehelprequired to
浏览 35
提问于2021-05-11
得票数 1
回答已采纳
1
回答
在
readthedocs
上
突出显示nbsphinx语法
、
、
、
我有一个
readthedocs
sphinx
文档
,
它
使用
nbsphinx来显示jupyter笔记本。
当我
使用
autobuild
在
本地
构建
文档
时
,我
在
jupyter笔记本
的
代码单元格中突出显示了语法。
但是
在
readthedocs
中,代码单元格没有任何语法突出显示。 有没有什么东西我必须激活才能在
浏览 21
提问于2020-02-12
得票数 0
点击加载更多
扫码
添加站长 进交流群
领取专属
10元无门槛券
手把手带您无忧上云
相关
资讯
如何使用 Python在30 分钟内快速搭建博客?
以正确的方式开源 Python 项目
用Python教你30分钟快速搭建自己的博客
快速开发:用Python快速编写博客平台
用Python 30分钟教你快速搭建一个博客
热门
标签
更多标签
云服务器
ICP备案
实时音视频
即时通信 IM
对象存储
活动推荐
运营活动
广告
关闭
领券