腾讯云
开发者社区
文档
建议反馈
控制台
首页
学习
活动
专区
工具
TVP
最新优惠活动
文章/答案/技术大牛
搜索
搜索
关闭
发布
登录/注册
精选内容/技术社群/优惠产品,
尽在小程序
立即前往
文章
问答
(9999+)
视频
沙龙
1
回答
Sphinx
的
文档
标记
版本
python
、
versioning
、
python-sphinx
我正在使用下面的
Sphinx
为我
的
项目生成
文档
。如何根据标签/分支生成多个
版本
? 我确实检查了库sphinxcontrib-versioning,但由于它最近没有更新,它似乎损坏了。有什么我可以调查
的
吗?有人能告诉我来源吗?
浏览 12
提问于2019-07-04
得票数 1
1
回答
我在哪里可以得到pdf格式
的
官方PyTorch
文档
?
printing
、
pytorch
、
resources
我在PyTorch
的
主站点上看到了所有的
文档
和教程。但是,我想把打印出来
的
东西拿去读一下。当我从网站页面获取打印输出时,我得到
的
是非常小
的
字母,这对我来说很难阅读。一般来说,大多数软件包都提供了一个pdf链接来下载所有与软件包相关
的
详细信息。我在PyTorch
的
主站点上找不到这样
的
选项。 官方PyTorch上有这样
的
资源吗?
浏览 13
提问于2021-07-02
得票数 1
2
回答
使用
Sphinx
从单个源生成内部和外部
文档
python-sphinx
、
conditional-compilation
我试图找到关于
Sphinx
将某些
文档
标记
为“内部”并像
sphinx
-build -b -include internal source output一样构建
文档
的
能力
的
信息,其中-include标志将包含一系列要包含在输出中
的
标记
这将允许我生成两个
版本
(或更多)
的
我
的
文档
,同时保持它
的
单一来源。有没有这样
的
机制?如果不是,这会很
浏览 2
提问于2017-05-12
得票数 2
回答已采纳
1
回答
在使用
sphinx
-autoapi部署过程中
的
持久缓存?
python
、
gitlab
、
python-sphinx
、
docstring
我正在尝试将用
Sphinx
生成
的
本地
文档
部署到Gitlab页面。/docs/ public paths: only:我在狮身人面像构建过程中使用了
标记
-E和-a来强制重建所有的HTML页面,但是狮身人面像仍然没有捕捉到对
文档
字符串
的
更新更改。我正在使用
sphinx
,并且尝试将autoapi_dirs指向正确
的
目录: autoapi_dirs =
浏览 8
提问于2022-09-19
得票数 1
回答已采纳
1
回答
如何在GitHub上托管基于狮身人面像
的
多个
版本
的
文档
?
python
、
python-sphinx
当使用Github页面托管
Sphinx
文档
时,可能希望为代码
的
不同分支或
标记
托管多个
版本
的
相同
文档
。但是,sphinxcontrib-multiversion和sphinxcontrib-versioning都没有得到积极
的
维护,而且它们也不适用于狮身人面像
的
最新
版本
。如果一个人不想使用ReadTheDocs,并且想坚持Alabaster
的
主题,什么是正确
的
解决方案?
浏览 10
提问于2022-05-02
得票数 1
1
回答
在Jupyter中使用
Sphinx
渲染docstring
jupyter-notebook
、
python-sphinx
有没有办法让Jupyter notebooks在Jupyter notebooks中正确呈现包含
Sphinx
标记
的
文档
字符串?目前,如果我有一个包含
Sphinx
文档
的
Foo类,并且用户尝试使用以下命令获取
文档
字符串 [1] Foo.bar? 他们最终得到了原始文本。例如。有没有办法让Jupyter自动将
文档
字符串正确地呈现为
Sphinx
。或者任何比raw rst更容易阅读
的
东西?
浏览 38
提问于2021-08-30
得票数 1
回答已采纳
1
回答
如何设置狮身人面像
文档
的
开图元数据
标记
?
python-sphinx
、
restructuredtext
我希望在我
的
斯芬克斯
文档
中为添加元
标记
。我看到狮身人面像有这个元 :description: The
Sphinx
documentation builder但是如何使用它来
标记
属性属性(如<meta property="og:title" content="<title>" /> ) --我只看到
浏览 3
提问于2022-02-01
得票数 1
回答已采纳
2
回答
sphinx
-显示分支而不是
版本
号
的
版本
控制
versioning
、
python-sphinx
我已经完全完成了
sphinx
-versioning
的
tutorial。运行以下命令后,我获得了一个新
的
index.html。
sphinx
-versioning build -r feature_branch docs docs/_build/html open docs/_build/html/index.html ? 但是,我希望使用0.5.0和0.6.0等
版本
号,而不是分支。如何使用
版本
号而不是分支来堆叠
文档
?
浏览 47
提问于2020-11-06
得票数 1
3
回答
Sphinx
文档
生成器
的
Ruby等价物?
ruby
、
markdown
、
documentation-generation
、
python-sphinx
、
restructuredtext
Ruby有一些很好
的
文档
生成器,比如Yard,rDoc,甚至字形。事实是斯芬克斯做网站,PDF,epub,LaTex...etc。它在restructuredtext中做了所有这些事情。在Ruby
的
世界里,有没有别的选择呢?也许是程序
的
组合?如果我也能使用Markdown,那就更好了。
浏览 0
提问于2012-02-21
得票数 6
1
回答
如何通过readthedocs构建中
的
脚本修改用斯芬克斯构建
的
文档
python-sphinx
、
read-the-docs
我正在尝试运行一个脚本来修改由Read托管
的
sphinx
构建
的
文档
(因为有些链接没有得到正确
的
处理)。当我试图在本地构建脚本时,脚本可以工作,但在读取
文档
生成时失败,或者更改不会传播到网站。我试图运行
的
脚本非常简单,它替换了一些没有被
sphinx
标记
表正确转换
的
html链接:# Required # Build documentation in the docs/
浏览 11
提问于2022-08-23
得票数 1
1
回答
使用
Sphinx
napoleon创建到标准库其他
版本
的
类型链接
python-sphinx
、
sphinx-napoleon
我使用
Sphinx
、拿破仑和autodoc扩展来解析Google风格
的
文档
字符串,并记录了一个Python项目。由于Google样式涉及指定参数
的
类型,因此
Sphinx
会自动创建指向标准库中标准类型
文档
的
链接。然而,在默认情况下,Intersphinx链接到2.7
版本
的
文档
,而我想链接到3.x
版本
。
浏览 4
提问于2016-06-14
得票数 0
1
回答
阅读
文档
不包括主题css
python
、
css
、
makefile
、
read-the-docs
我正在使用下面的conf.py在本地编译Readthedocs,它运行得很好:### extensions coming with
Sphinx
(na
浏览 2
提问于2018-09-21
得票数 2
回答已采纳
1
回答
autodoc复制class
的
方法
python
、
python-sphinx
、
autodoc
自动生成
的
文档
复制了Test类
的
Methods,如下所示。为什么会发生这种重复,如何才能阻止它? 我在conf.py模块中尝试了几个变体,但都没有用。在
文档
图像之后,是此模块
的
编辑
版本
。extensions = ['
sphinx
.ext.autodoc', 'numpydoc',
浏览 17
提问于2020-08-07
得票数 1
回答已采纳
2
回答
是否从
sphinx
autodoc中发出reStructuredText?
python
、
python-sphinx
、
autodoc
CPython
的
文档
没有使用autodoc --我们使用
的
是手写
的
文章。使用
sphinx
-apidoc为依赖于autodoc
的
模块发出
Sphinx
项目运行创建新reStructuredText源文件
的
sphinx
构建器,其中所有autodoc指令都替换为内联reSt
浏览 60
提问于2012-04-30
得票数 22
回答已采纳
1
回答
Sphinx
PDF输出不包括从代码自动生成
的
文档
python
、
latex
、
python-sphinx
、
autodoc
html生成
的
文件很好,并且提供了从代码自动生成
的
文档
,但是pdf文件几乎是空
的
,并且只包含rst文件中
的
内容。extensions = ['
sphinx
.ext.todo', '
sphinx
.ext.autodoc', '
sphinx
.
浏览 25
提问于2021-08-12
得票数 0
1
回答
如何在HTML输出中向docutils
sphinx
引用添加rel属性?
html
、
hyperlink
、
python-sphinx
、
docutils
我对
Sphinx
文档
实用程序有一个简单
的
扩展(我正在使用
的
版本
是
Sphinx
-1.1.3-py2.6)。非常像道格·赫尔曼( Doug )
的
优秀例子。如何将rel='bar'属性添加到<a ...>
标记
的
最终HTML中?通过搜索源,我找到了
sphinx
/writers/html.py和HTMLTranslator类。在这方面我找不到任何有用
的
东西。
浏览 1
提问于2012-10-31
得票数 3
1
回答
Sphinx
使用旧
的
模块代码
python
、
documentation
、
python-sphinx
我使用
Sphinx
来记录我
的
代码,它是Python模块
的
集合。通过清理源代码自动生成
的
文档
没有问题,但是当我单击直接链接到包含
Sphinx
生成
的
包
的
源代码
的
HTML页面的" code“链接时,会显示我
的
代码
的
一个较旧
版本
。我尝试删除我
的
Sphinx
生成
的
文档
,从我自己
的
site-pa
浏览 2
提问于2013-06-28
得票数 3
回答已采纳
1
回答
狮身人面像CommonMarkParser没有检测到网址链接
markdown
、
python-sphinx
、
myst
我正在使用狮身人面像(
Sphinx
)构建一个基于Markdown文件
的
文档
。
文档
非常清楚,myst解析器应该以典型
的
[some text](www.example.com)方式处理
标记
链接。,这显然不是预期
的
链接。,但最终得到
的
输出是相同
的
。如何解决这个相当简单
的
问题呢?正在使用
的
版本
: recommonmark 0.7.1 myst-解析器0.13.6
sphinx<
浏览 3
提问于2021-04-19
得票数 0
回答已采纳
1
回答
在Django中使用带有
sphinx
的
用户输入
python
、
django
、
python-sphinx
我正尝试在我
的
django项目中使用
sphinx
。我特别想要做
的
是接受用户
的
输入,将它们保存在某个地方(我最终会推送),并用
sphinx
显示他们
的
输入。用户将能够创建他们自己
的
文档
版本
,toc...etc,我
的
表单将告诉他们这样做,它将接受他们
的
输入并与
sphinx
进行交互。我没有看到任何关于这方面的帮助或
文档
浏览 0
提问于2013-10-11
得票数 1
1
回答
如何让
Sphinx
在HTML构建中显示继承图?
python-3.x
、
python-sphinx
、
graphviz
我正在使用
Sphinx
从py模块生成一个类图。根据
Sphinx
文档
,我在RST文件中为我希望绘制
的
模块使用了继承图指令。但是,构建只生成Graphviz
标记
,而不是实际
的
绘图。我已经在我
的
Sphinx
配置文件中包含了inheritance_diagram和Graphviz。为了获得图形输出,我还需要其他指令吗?谢谢。
浏览 0
提问于2015-03-20
得票数 2
点击加载更多
扫码
添加站长 进交流群
领取专属
10元无门槛券
手把手带您无忧上云
相关
资讯
Parascript发布智能文档处理解决方案的新版本
为什么不应该使用Markdown来写文档
快速开发:用Python快速编写博客平台
如何使用 Python在30 分钟内快速搭建博客?
用Python教你30分钟快速搭建自己的博客
热门
标签
更多标签
活动推荐
运营活动
广告
关闭
领券