腾讯云
开发者社区
文档
建议反馈
控制台
首页
学习
活动
专区
工具
TVP
最新优惠活动
文章/答案/技术大牛
搜索
搜索
关闭
发布
登录/注册
精选内容/技术社群/优惠产品,
尽在小程序
立即前往
文章
问答
(9999+)
视频
沙龙
1
回答
在
Python
Sphinx
生成
的
文档
中
包含
动态
内容
python-sphinx
我正在使用
Sphinx
为我
的
项目
生成
文档
,并将构建
文档
作为产品安装过程
的
一部分。 我希望
在
文本和/或代码块
中
动态
包含
主机名。我
在
文档
中
没有看到任何解释,也没有看到任何工具来
包含
shell命令
的
输出,或者除了特定文件
中
的
特定行之外
的
任何
内容
。此功能是
浏览 1
提问于2013-04-18
得票数 9
回答已采纳
1
回答
如何解析多个文本文件并将所需输出附加到单个文件。(用于文件)
python
、
documentation
、
bdd
、
python-behave
我正在使用
Python
-行为框架来执行BDD测试,在这里,我将测试写成了“功能和场景”,并在“步骤”
中
编写了相关
python
代码。我尝试使用:-‘Pydoc’来捕获所使用
的
python
文件
的
名称、函数和相关
的
注释。
python
-m pydoc
浏览 1
提问于2019-09-09
得票数 0
1
回答
如何使用
Sphinx
链接本地
Python
帮助
文档
python-sphinx
、
toctree
如何让我
的
Sphinx
RST文件
包含
到"contents.html“
Python
帮助页面的链接?我
在
离线环境中有一个RST帮助
文档
(index.rst)。然后,我更新了我
的
conf.py文件,以
包含
以下Intersphinx映射:然
浏览 71
提问于2018-05-26
得票数 2
1
回答
Sphinx
PDF输出不包括从代码自动
生成
的
文档
python
、
latex
、
python-sphinx
、
autodoc
我
在
python
项目中使用了以下conf.py。html
生成
的
文件很好,并且提供了从代码自动
生成
的
文档
,但是pdf文件几乎是空
的
,并且只
包含
rst文件
中
的
内容
。extensions = ['
sphinx
.ext.todo',
浏览 25
提问于2021-08-12
得票数 0
1
回答
Sphinx
使用旧
的
模块代码
python
、
documentation
、
python-sphinx
我使用
Sphinx
来记录我
的
代码,它是
Python
模块
的
集合。通过清理源代码自动
生成
的
文档
没有问题,但是当我单击直接链接到
包含
Sphinx
生成
的
包
的
源代码
的
HTML页面的" code“链接时,会显示我
的
代码
的
一个较旧版本。我尝试删除我
的
Sphinx
生成
的</
浏览 2
提问于2013-06-28
得票数 3
回答已采纳
1
回答
Python
-
sphinx
:忽略.rst文件
中
的
文本
python
、
github
、
python-sphinx
我
在
GitHub上有一个README.rst,它也被合并到一个
Python
项目的
Sphinx
生成
的
文档
中
。我想在文件
的
顶部添加一条注释,该注释将显示
在
GitHub上(它只是呈现.rst),但不会显示
在
由
Sphinx
生成
的
文档
中
。我知道可以使用.. blah blah blah
在
.rst文件
中
<
浏览 0
提问于2016-03-07
得票数 3
2
回答
从setup.py安装
sphinx
编译
的
文档
python
、
python-sphinx
、
setuptools
、
restructuredtext
、
setup.py
我想安装一些HTML,它是使用rSt和
python
代码一起使用
生成
的
(理解从编译)到站点包
中
。我想用setup.py实现这一点。具体来说,我想将我
的
*.rst文件简化为setup.py,然后在用户输入
python
setup.py install时从
python
setup.py install文件复制到站点包
中
。我查看了狮身人面像和setuptools
文档
,但是找不到相关信息。 我之所以想这么做,是因为我
的
包是一个
浏览 4
提问于2015-02-25
得票数 1
回答已采纳
2
回答
狮身人面像将NumPy模块
的
文档
添加到我
的
文档
中
python
、
python-sphinx
我想为我
的
Python
代码
生成
Sphinx
文档
。此代码从numpy进行一些导入。我
在
mycode上使用
sphinx
-apidoc,然后运行make html。它
生成
文档
,但也包括uniform函数
的
文档
,这些
文档
来自其中
的
numpy。如何禁用这些冗余
的
包含
?这是我
的
代码:&
浏览 2
提问于2014-05-08
得票数 2
回答已采纳
1
回答
到
Sphinx
文档
中
的
外部git存储库
的
超链接
python
、
python-sphinx
到表单
中
的
git存储库
的
外部超链接
在
HTML
文档
中正确显示,但它们没有显示
在
PDF文件
中
。运行
python
setup.py
sphinx
_build -b latex以
生成
LaTeX文件时会出现警告: unusable reference target found git:&
浏览 2
提问于2013-09-01
得票数 4
回答已采纳
1
回答
如何获取纯数据格式
的
Python
Sphinx
文档
?
python
、
python-sphinx
、
restructuredtext
我正在开发一个非常大
的
代码库,它使用
sphinx
-apidoc从
Python
源代码
中
的
文档
字符串自动
生成
HTML
文档
。
文档
字符串使用以下格式::type message: string:rtype:字符串 将
Sphinx
HTML
文档
替换为以不同方式组织/表示
的</e
浏览 1
提问于2012-10-27
得票数 4
回答已采纳
5
回答
如何使用Doxygen为
Python
代码编写
文档
python
、
documentation
、
python-sphinx
、
doxygen
、
docstring
我喜欢Doxygen来创建C或PHP代码
的
文档
。我有一个即将到来
的
Python
项目,我想我记得
Python
没有/* .. */注释,而且还有自己
的
自我
文档
工具,这似乎是
Python
的
文档
编制方式。既然我熟悉Doxygen,那么我如何使用它来
生成
我
的
Python
文档
呢?有什么特别需要我注意
的
吗?
浏览 0
提问于2008-09-12
得票数 99
回答已采纳
1
回答
避免水泥配置
的
Sphinx
格式错误
python-sphinx
、
cement
我们使用
Sphinx
来格式化
Python
文档
,使用cement来配置CLI。不幸
的
是,
Sphinx
会从cement配置中
生成
大量无意义
的
输出。我找不到任何
Sphinx
指令或命令行选项来忽略不应该格式化
的
水泥配置。我们使用
的
是
Sphinx
2.2.0和带有选项-f -P -o
的
sphinx
-apidoc。例如,
Sphinx
对此
Python<
浏览 1
提问于2019-09-10
得票数 0
3
回答
如何从
python
生成
reST/
sphinx
源代码?
python
、
documentation-generation
、
restructuredtext
、
python-sphinx
我想通过reST
生成
文档
,但不想手动编写reST源代码,但让
python
脚本来做这件事,然后用
sphinx
生成
其他格式(HTML )。 phone_book = PhonebookParser("somefile.bin") restdoc = restProd
浏览 11
提问于2011-03-13
得票数 7
回答已采纳
1
回答
sphinx
,buildbot (和代码覆盖率)。它们是如何集成
的
?
python
、
code-coverage
、
python-sphinx
、
documentation-generation
我有一个不是很小
的
python
包,有相当多
的
历史记录,用
文档
字符串记录。
在
它
的
开发过程
中
,我们引入了,后来又引入了。最近,我
在
我
的
buildbot.cfg
中
添加了一个食谱,以便从源代码
中
收集
文档
,并保持网络可访问
文档
的
最新状态。到目前为止,一切顺利:每次我提交更改时,Jenkins都会负责广泛地检查包,
生成
非常完整
的</
浏览 2
提问于2011-03-03
得票数 3
回答已采纳
1
回答
如何在依赖于原地构建
的
Python
项目中使用
Sphinx
?
c++
、
makefile
、
cython
、
python-sphinx
我有一个主要是
Python
的
大型项目,我正在尝试记录该项目。这个项目的一部分依赖于C++源代码,这些源代码可以通过Cython访问。当像正常一样运行代码时,它运行得很好,但在尝试使用
Sphinx
进行自动
文档
记录时,我遇到了问题。我认为this guy
的
想法是对
的
,但我不能让它起作用。我
的
Makefile看起来像这样 # Minimal makefile for
Sphinx
documentation # You can set these va
浏览 34
提问于2020-10-11
得票数 0
回答已采纳
4
回答
Python
命令行程序:从现有
文档
生成
手册页,并将其
包含
在发行版
中
python
、
python-sphinx
、
distutils
遵循一个(希望如此)
的
通用实践,我有一个
Python
包,它
包含
了几个模块和一个单独
的
scripts目录
中
的
可执行脚本,就像我们可以看到
的
。该脚本
的
文档
,除了opt解译提供
的
自动
生成
的
帮助之外,还与
Sphinx
子目录
中
的
包
文档
一起使用。我试图: 从现有
文档
中
为脚本
生
浏览 9
提问于2013-03-08
得票数 13
2
回答
genindex和modindex页脚链接在readthedocs.io
中
不起作用
python-sphinx
、
restructuredtext
、
read-the-docs
、
autodoc
我有一个
Python
项目,使用
Sphinx
作为
文档
。我正在readthedocs.io服务上远程构建
文档
。遵循本指南:,我运行了
sphinx
-apidoc -o api-docs/ ../myproject来
生成
自动
文档
.rst文件。我
在
我
的
api-docs/modules.rst顶部
的
toctree部分链接了结果index.rst.该链接正常工作,如果我通过api-docs单击就可以正
浏览 2
提问于2020-11-05
得票数 0
回答已采纳
1
回答
使viewcode显示模块源代码
python
、
python-sphinx
我正在尝试使用
Sphinx
将一些
Python
代码片段制作成一本食谱。每个代码片段都是一个自
包含
的
Python
脚本,并且都有一个教程类型
的
doctsring。我想在
生成
的
文档
中有一个源链接,以显示脚本
内容
。但是似乎不会为模块创建此链接,而是仅为函数或具有
文档
字符串
的
类创建此链接。有没有办法诱使
在
不
包含
任何类/函数
的
情况下
浏览 1
提问于2014-08-29
得票数 3
1
回答
如何让
Sphinx
忽略我
的
文档
字符串
中
的
GPL通知?
python
、
python-sphinx
、
docstring
我正在使用
Sphinx
来记录我
的
Python
包。当我
在
我
的
模块上使用自动模块指令时::members: 它打印
文档
字符串
中
的
所有
内容
,包括GPL通知。有没有办法告诉
Sphinx
忽略docstring/GPL,或者我应该把它
包含
在
文档
中
?
浏览 0
提问于2013-06-20
得票数 8
回答已采纳
3
回答
docutils和
Sphinx
之间
的
关系是什么?
python
、
documentation-generation
、
python-sphinx
、
epydoc
似乎有太多
的
Python
文档
工具。我遇到
的
另一个是epydoc。看起来
Sphinx
是事实上
的
标准,因为它被用来
生成
官方
的
Python
文档
。有人能帮我整理一下
Python
文档
工具
的
现状吗?
浏览 5
提问于2010-03-14
得票数 28
回答已采纳
点击加载更多
扫码
添加站长 进交流群
领取专属
10元无门槛券
手把手带您无忧上云
相关
资讯
sphinx生成项目文档
如何使用 Python在30 分钟内快速搭建博客?
快速开发:用Python快速编写博客平台
用Python教你30分钟快速搭建自己的博客
以正确的方式开源 Python 项目
热门
标签
更多标签
云服务器
即时通信 IM
ICP备案
对象存储
实时音视频
活动推荐
运营活动
广告
关闭
领券