腾讯云
开发者社区
文档
建议反馈
控制台
首页
学习
活动
专区
工具
TVP
最新优惠活动
文章/答案/技术大牛
搜索
搜索
关闭
发布
登录/注册
精选内容/技术社群/优惠产品,
尽在小程序
立即前往
文章
问答
(9999+)
视频
沙龙
1
回答
在
文档
字符串
sphinx
中
添加
字典
键
、
、
、
为
字典
的
键
添加
文档
字符串
的推荐方式是什么?我使用的是python 2.7和
Sphinx
。 例如,在下面的代码
中
,我应该如何提到my_dict的
键
'a‘和'b’?my_dict: description of param pass 我的Pycharm编辑器似乎无法识别上面的实现 编辑:我也读了this post,但答案没有提到如何指定
键
的
浏览 10
提问于2019-03-08
得票数 5
5
回答
在
Sphinx
文档
中
显示
字典
数据
、
我
在
Python项目源代码中有一个
字典
,它描述默认的配置值。这本词典很长。我希望
在
Sphinx
文档
中看到除“查看源”之外的其他格式的
字典
,以便人们能够快速检查默认值。当与
Sphinx
autodoc一起使用时,
Sphinx
提供了将类似
字典
的变量格式化为人类可读的格式的选项吗?目前,我正在使用.. automodule::将整个模块转储出来,我将
字典
作为
文档
中
的一个长
字符串<
浏览 10
提问于2015-01-10
得票数 18
回答已采纳
4
回答
字典
-
添加
注释以驱动智能感知
、
、
有没有办法将注释
添加
到
文档
字典
或ConcurrentDictionary
中
,以了解
键
/值的含义?Dictionary<guid, string> _users;有没有办法
添加
文档
,这样当你
添加
项目时,智能感知会告诉开发人员关于
键
和值的注释?我知道我可以
在
浏览 0
提问于2012-05-03
得票数 6
回答已采纳
2
回答
使用NumPyDoc样式的带有Napoleon
Sphinx
扩展的类方法列表
、
、
、
我正在使用NumPyDoc样式的
文档
字符串
来记录一个Python包。我想从
Sphinx
扩展切换到,因为我发现它以更紧凑和可读性更强的方式格式化了
文档
字符串
。但是,它没有
在
文档
的顶部列出类的方法,这是numpydoc的一个非常有价值的特性。有人知道如何在拿破仑
中
手动打开它吗?
浏览 18
提问于2017-01-20
得票数 10
1
回答
如何在
sphinx
文档
中
自动
添加
参数类型
、
、
、
、
我目前正在尝试使用
Sphinx
(使用
sphinx
-apidoc和napoleon扩展名)实现自动
文档
创建。这工作得很好,但如果类型提示(PEP484约定)自动
添加
到参数列表
中
,那就更好了。可以手动
添加
它们,但当决定更改签名时,这可能会带来未来的问题。手动
添加
类型的示例: ""&quo
浏览 41
提问于2018-03-29
得票数 10
回答已采纳
4
回答
使用
sphinx
的autodoc继承属性的Docstring
、
、
object): """Documentation for property x"""class MyObj(MyBase):当我使用
sphinx
的autodoc生成
文档
时,MyObj.x没有
文档
。有没有办法从MyBase.x继承
文档
字符串
?我发现了,但是因为它使用了一个装饰器,所以它只适用于类方法。有什么方法可以用属性做到这一点吗?
浏览 0
提问于2011-04-02
得票数 3
回答已采纳
7
回答
如何在使用
sphinx
生成python
文档
时保留换行符
、
我正在使用
Sphinx
为python项目生成
文档
。输出html不会保留
文档
字符串
中
存在的换行符。description None print "I am a test method"
Sphinx
浏览 12
提问于2011-08-12
得票数 56
1
回答
sphinx
,buildbot (和代码覆盖率)。它们是如何集成的?
、
、
、
我有一个不是很小的python包,有相当多的历史记录,用
文档
字符串
记录。
在
它的开发过程
中
,我们引入了,后来又引入了。最近,我
在
我的buildbot.cfg
中
添加
了一个食谱,以便从源代码
中
收集
文档
,并保持网络可访问
文档
的最新状态。到目前为止,一切顺利:每次我提交更改时,Jenkins都会负责广泛地检查包,生成非常完整的概述并更新我们的
文档
站点。 我启用的一个
sphinx
扩展是:,用于
浏览 2
提问于2011-03-03
得票数 3
回答已采纳
1
回答
如何在
sphinx
中选择sql源查询
中
的列
我使用
sphinx
索引器根据mysql
中
的
文档
创建
字典
,但不能将源的sql查询限制
在
选定的列上。使用development.
sphinx
.conf
中
的以下源代码,将不会找到任何
文档
,并且dict.txt为空 type = mysql sql_hostWARNING: key 'max_matches' was permanently removed from
Sphin
浏览 3
提问于2017-03-21
得票数 0
回答已采纳
1
回答
Sphinx
文档
: conf.py变量的翻译(i18n)
、
、
在
sphinx
文档
项目中,如何向conf.py
中
定义的变量
添加
翻译 举个恰当的例子:project变量是"<Brand Name> Setup and Configuration Manual",我想把后面的部分翻译过来使用标准i18n工具时,.pot文件
中
缺少这些值。我也找不到如何在conf.py
中
获取命令行指定的语言(通过硬编码
字典
进行翻译)。
浏览 9
提问于2019-04-23
得票数 1
1
回答
自定义过滤
sphinx
中
的方法
、
、
、
我想在我的
sphinx
文档
中
添加
一个菜单"todo items",它应该包含我的项目的所有方法,其中包含一些todo项,如下所示: “:todo:函数àimplémenter” 我想要显示类的名称、相关方法的名称我发现了一些可能相关的东西:http://www.pythondoc.com/
sphinx
/ext/autodoc.html#skipping-members,但它只过滤方法,似乎没有链接到所需的信息(
浏览 50
提问于2019-07-03
得票数 0
1
回答
如何在狮身人面像
中
添加
单词?
如何使用java将我的话
添加
到狮身人面像?我是一个学习狮身人面像的新学习者,我只是知道如何使用它,我想学习
添加
我的words.anybody可以帮助我。
浏览 4
提问于2013-09-19
得票数 2
1
回答
如何获取纯数据格式的Python
Sphinx
文档
?
、
、
我正在开发一个非常大的代码库,它使用
sphinx
-apidoc从Python源代码
中
的
文档
字符串
自动生成HTML
文档
。
文档
字符串
使用以下格式::type message: string:rtype:
字符串
将
Sphinx
HTML
文档
替换为以不同方式组织/表示的内容已经成为一种需求--但我们仍然希望从源代码<e
浏览 1
提问于2012-10-27
得票数 4
回答已采纳
1
回答
如何从python
文档
字符串
生成web API
文档
在
视图函数
中
,我有关于REST urls的
文档
,我想为REST urls生成API
文档
。Parameters: None """但是当我
在
myproject.api.views上运行
sphinx
时,我得到了用python调用api的html
浏览 0
提问于2013-01-21
得票数 0
回答已采纳
4
回答
如何将
字典
保存到文件
中
,保持良好的格式?
、
、
、
、
如果我有
字典
的话: "cats": { "british": 2 "dogs": {}尝试将其保存到文本文件
中
,我得到如下内容:我怎样才能把
浏览 2
提问于2016-03-19
得票数 6
回答已采纳
1
回答
在
Jupyter中使用
Sphinx
渲染docstring
、
有没有办法让Jupyter notebooks
在
Jupyter notebooks中正确呈现包含
Sphinx
标记的
文档
字符串
?目前,如果我有一个包含
Sphinx
文档
的Foo类,并且用户尝试使用以下命令获取
文档
字符串
[1] Foo.bar? 他们最终得到了原始文本。例如。有没有办法让Jupyter自动将
文档
字符串
正确地呈现为
Sphinx
。或者任何比raw rst更容易阅读的东西?
浏览 38
提问于2021-08-30
得票数 1
回答已采纳
1
回答
在
sphinx
autodoc
中
禁用模块成员内容
、
我正在使用
sphinx
自动对接一个python模块。例如,我
在
文件test.py
中
的代码如下:"""当我
在
rst文件
中
写这段代码时: :mem
浏览 1
提问于2016-03-25
得票数 0
1
回答
UIT不适用于相册
我已经注册了我的应用程序打开所有的文件类型,这是很好的,但我不能让它与图像工作,它不会出现在PhotoAlbum
中
,但我的应用程序出现在safari和safari可以发送给我打开某些文件的请求。
浏览 0
提问于2013-02-08
得票数 0
4
回答
自动从epydoc的
文档
字符串
格式切换到
sphinx
文档
字符串
格式?
、
、
、
、
我有一个使用epydoc进行
文档
记录的项目。现在我正试着换成斯芬克斯。我为epydocs设置了所有
文档
字符串
的格式,使用B{}、L{}等进行加粗、链接等操作,并使用@param、@return、@raise等来解释输入、输出、异常等。所以现在我切换到了
sphinx
,它失去了所有这些特性。有没有一种自动的方法将epydocs格式的
文档
字符串
转换为
sphinx
格式的
文档
字符串
?
浏览 3
提问于2012-04-04
得票数 10
回答已采纳
2
回答
用于ReadtheDocs安装的setup.py配置
我正在尝试自动将一个项目从Github导入到ReadtheDocs
中
。
在
创建
文档
时,由于缺少依赖关系而失败。我尝试
在
配置
中
添加
setup.py安装,但遇到以下情况: # Required version: 2# Build docum
浏览 0
提问于2019-09-07
得票数 6
点击加载更多
扫码
添加站长 进交流群
领取专属
10元无门槛券
手把手带您无忧上云
相关
资讯
在word文档中怎么添加编号?
PDF技巧之如何快速在文档中添加图片
PDF技巧之如何快速在文档中添加水印
怎么在PDF文档中添加表单域?
Excel–使用快捷键在图表中快速添加、删除数据系列
热门
标签
更多标签
云服务器
ICP备案
实时音视频
即时通信 IM
对象存储
活动推荐
运营活动
广告
关闭
领券