腾讯云
开发者社区
文档
建议反馈
控制台
首页
学习
活动
专区
工具
TVP
最新优惠活动
文章/答案/技术大牛
搜索
搜索
关闭
发布
登录/注册
精选内容/技术社群/优惠产品,
尽在小程序
立即前往
文章
问答
(9999+)
视频
沙龙
1
回答
Sphinx
文本
包含
指令
中
的
缩进
块
python-sphinx
、
restructuredtext
我
的
文件中有一段代码,我希望使用literalinclude
指令
将其
包含
在
Sphinx
文档
的
示例
中
。但是这些代码是在一个函数
中
,所以当我
包含
它
的
时候,在这个例子
中
,每一行
的
缩进
比我想要
的
要多一个级别。 .. literalinclude:: ../..tab-width: 0 产生 import foo from foo import b
浏览 16
提问于2021-11-16
得票数 1
回答已采纳
1
回答
左对齐
Sphinx
HTML输出
中
的
所有数学
块
python-sphinx
、
mathjax
、
restructuredtext
我有通过
包含
数学
块
的
狮身人面像文档。默认情况下,它们以HTML输出为中心。我希望它们都在左边对齐,但对周围
的
文本
有一些
缩进
。例如,如果是在index.rst
中
is in fact centere
浏览 19
提问于2021-12-14
得票数 0
回答已采纳
4
回答
如何在生成代码文档时删除意外
缩进
警告
的
原因?
python-2.7
、
windows-10
、
python-sphinx
、
restructuredtext
、
msys2
该问题
的
文档代码位于方法
的
开头:Gtk.EventBox::button-release-event signal handler.
浏览 4
提问于2017-08-25
得票数 29
回答已采纳
1
回答
斯芬克斯有可能保留长队吗?
python-sphinx
、
restructuredtext
我对狮身人面像
的
restructuredText输入文件有很长
的
一行:This is a long line text that I want to keep as a long single line.我想保持单排长队
的
原样。这个是可能
的
吗? 使用是在本中提出
的
。但是
浏览 0
提问于2018-05-10
得票数 1
2
回答
Sphinx
文档变量
python
、
python-sphinx
我正在使用
Sphinx
为一个新项目编写文档我知道
Sphinx
上有一个i18n功能,所以我可以使用gettext来更改“项目名称”,而不需要其他东西。但我正在寻找一种合适
的
方法来做到这一点。
浏览 0
提问于2013-02-28
得票数 6
回答已采纳
1
回答
自定义过滤
sphinx
中
的
方法
python
、
python-sphinx
、
documentation-generation
、
code-documentation
我想在我
的
sphinx
文档
中
添加一个菜单"todo items",它应该
包含
我
的
项目的所有方法,其中
包含
一些todo项,如下所示: “:todo:函数àimplémenter” 我想要显示类
的
名称、相关方法
的
名称我发现了一些可能相关
的
东西:http://www.pythondoc.com/
sphinx
/ext/autodoc.html#skippi
浏览 50
提问于2019-07-03
得票数 0
1
回答
在reST
中
需要3空间
缩进
吗?
python
、
python-sphinx
、
restructuredtext
我正在使用
Sphinx
记录我
的
Python代码,并阅读 (我认为其他地方也是如此),reST文件使用3个空格
的
缩进
: 所有reST文件都使用3个空格
的
缩进
;不允许使用制表符。这就是我为索引文件复制
的
示例,以及IDE获取3空间
缩进
并用于整个页面的其他一些文件。
sphinx
-apidoc扩展还为它构建
的
modules.rst文件使用了3个空格。另一方面,由于Python使用4空间
缩进
,所以我
的
浏览 1
提问于2018-01-17
得票数 14
回答已采纳
1
回答
指令
在呈现
的
文档
中
显示为文字
文本
。
python
、
python-sphinx
、
restructuredtext
、
sections
、
autodoc
我希望在两个节标题之间显示两个函数
的
docstring,如下所示:APIS3这两个文档字符串都出现在呈现
的
HTML
中
,但是第二个函数也将
Sphinx
指令
.. autofunction:: parsons.aws.event_command显示为docstring下面的
文本</e
浏览 2
提问于2020-10-08
得票数 1
回答已采纳
2
回答
如何在狮身人面像运行时预处理源文件?
python
、
python-3.x
、
vhdl
、
python-sphinx
、
read-the-docs
我已经为我
的
项目设置了
Sphinx
文档,并希望提取源文件
的
文档字符串并将它们嵌入到最终文档
中
。不幸
的
是,
Sphinx
不支持源文件
的
语言(VHDL)。VHDL似乎没有狮身人面像域。因此,我
的
想法如下: Python代码从每个源文件(最顶层
的
多行注释
块
)中提取
文本
块
,每个源文
浏览 2
提问于2016-05-24
得票数 11
回答已采纳
1
回答
RST条件
指令
不能使用标准语法
python-sphinx
、
restructuredtext
我在makefile
中
定义了一个条件标记,这样我就可以使用唯一
的
指令
有条件地删除
文本
块
。 ...设置BUILDDIR=_build通用:工作区:"xxx“。仅:内部XT -team-名称:XT使用
的
“菲尼克斯”#-不排除这一行** <以下列表项-必须保持put> “内部”
指令
可以工作,但是它清除了所有我不想
浏览 1
提问于2020-04-29
得票数 1
2
回答
在
Sphinx
/Pygments
中
,有没有办法在
文本
包含
中
强调一行或多行代码?
python
、
python-sphinx
、
pygments
在我正在编写
的
一些
sphinx
文档
中
,我
包含
了一个辅助文件
中
的
代码示例,如下所示: :pyobject: MyClass这个特别的文档是一个教程,其中
的
类是逐步构建
的
。我想要做
的
是
包含
整个类或单个方法,并且只强调对该部分感兴趣
的
行。这样就保留了上下文,但有趣
的
部分一目了然。现在,我已经
浏览 0
提问于2010-03-19
得票数 9
2
回答
在
Sphinx
中
创建文字
文本
块
python
、
python-sphinx
、
restructuredtext
我想在docstring
中
创建一个目录树,并且在不更改我
的
Sphinx
文档
的
情况下将它呈现出来,但是我遇到了麻烦。我认为后两者没有工作,因为这个
块
也是无效
的
Python/代码。此外,我还改变了
缩进
和间距
的
数量和类型,但没有用。 下面是我
的
示例(使用三条倒钩来描述所讨论
的
块
)。因此,我
的
问题是-如何呈现从docstring到
Sphinx
的
浏览 0
提问于2018-06-19
得票数 9
回答已采纳
1
回答
在
Sphinx
Makefile代码
块
中保存选项卡
python-sphinx
、
restructuredtext
我使用狮身人面像加上reStructuredText输入和HTML来记录基础结构
的
不同部分。这样做
的
想法是,阅读文档
的
用户可以复制示例并将它们传递到她
的
文件
中
。如何为Makefile示例做到这一点?Makefiles需要在某些地方使用制表符,但是
Sphinx
将制表符转换为空格。.. code-block:: Makefile
浏览 2
提问于2019-09-27
得票数 3
回答已采纳
1
回答
在
Sphinx
RTD站点
的
每个页面顶部添加警告
指令
python-sphinx
、
restructuredtext
、
read-the-docs
我想在
Sphinx
RTD站点
的
每个页面顶部添加一个简单
的
警告
指令
:我可以看到如何使用extrabody
块
添加一个
块
,但它出现在主内容区域之外,并且完全独立地定位和设置样式。理想情况下,我希望这个代码
块
显示在每个页面的面包屑下面的
浏览 13
提问于2020-05-14
得票数 2
1
回答
如何将超
文本
标记语言或可扩展标记语言嵌入到reStructuredText (
sphinx
)
中
,以便浏览器能够呈现它们?
python-sphinx
、
restructuredtext
我只需要在reStructuredText (
sphinx
)
中
嵌入一小段超
文本
标记语言或xml,这样浏览器就可以在生成
的
超
文本
标记语言文件
中
呈现它们,如下所示 <a href/><ci>a</ci><apply><minus/><ci>b</ci><ci>c</ci></apply&g
浏览 55
提问于2018-05-28
得票数 3
1
回答
如何让
Sphinx
测试文档
中
嵌入
的
代码?
python
、
python-sphinx
如果这段代码在我
的
文档
中
是
块
引用,我需要做什么才能让在文档生成时运行它?today(): if True:一个.rst源代码和conf.py
的
Sphinx
doctest扩展,但我收到了一个错误,抱怨函数体
的
第一行出现意外
缩进
。
Sphinx
的
doctest能够运行文档
中
定义
的</
浏览 0
提问于2010-01-08
得票数 4
回答已采纳
1
回答
如何在
Sphinx
中
创建无标题
的
带框
文本
?
python-sphinx
、
restructuredtext
在
Sphinx
中有几个用于创建装箱
文本
的
指令
,例如.. note::或.. topic::,但它们都
包含
一个标题。是否可以创建不带标题
的
带框
文本
?
浏览 19
提问于2020-04-26
得票数 2
1
回答
什么是“..替换“是指在第一个文件
中
吗?
include
、
comments
、
python-sphinx
、
restructuredtext
我有一个README.rst我用
Sphinx
渲染
的
文件。在那里面.rst我在文件末尾看到以下两行: .. substitutionsText有什么想法可以找到关于该
指令
的
适当文档,以及这个错误消息意味着什么? 谷歌搜索也无济于事。对于错误消息,我找到了3(!)仅提示。
浏览 39
提问于2021-02-23
得票数 2
回答已采纳
1
回答
Sphinx
:如何交叉引用由自定义
指令
生成
的
目标
python
、
python-sphinx
、
cross-reference
、
docutils
我在交叉引用由自定义
指令
生成
的
节时遇到问题。以下是
指令
:from docutils.parsers import rst app.add_directive('mytest', TestDirective) 下面是它
的
用法
浏览 14
提问于2020-04-22
得票数 7
2
回答
Sphinx
Napoleon扩展:用Google风格
的
文档字符串记录多个返回参数
python
、
python-sphinx
、
google-style-guide
、
sphinx-napoleon
建议和接受
的
解决方案是: (tuple): tuple containing: 我应该如何管理
sphinx
,
sphinx
.ext.napoleon和谷歌风格
的
文档字符串
的
多次返回?
浏览 7
提问于2015-07-15
得票数 7
点击加载更多
扫码
添加站长 进交流群
领取专属
10元无门槛券
手把手带您无忧上云
相关
资讯
文本识别专题-6-判断变量Var1中是否包含变量Var2任意一行观测中的字符串
文本识别专题-1-判断变量Var1是否包含变量Var2同一行观测中的字符串
Java特性专题报道:文本块
每日一模块:textwrap
Groovy中的模版引擎(二)
热门
标签
更多标签
活动推荐
运营活动
广告
关闭
领券