腾讯云
开发者社区
文档
建议反馈
控制台
首页
学习
活动
专区
工具
TVP
最新优惠活动
文章/答案/技术大牛
搜索
搜索
关闭
发布
登录/注册
精选内容/技术社群/优惠产品,
尽在小程序
立即前往
文章
问答
(9999+)
视频
沙龙
3
回答
Sphinx
将
Markdown
文件
中
的
标题
添加到
文档
结构
markdown
、
python-sphinx
、
toctree
、
commonmark
我已经
将
Sphinx
配置为使用
markdown
文件
。在我
的
index.rst
文件
中
.. toctree:: :caption: Contents: ## H2 Heading 当我渲染主页时,H2
标题
出现在toctree
中
浏览 27
提问于2019-02-21
得票数 0
回答已采纳
3
回答
基于狮身人面像
的
文档
标记输出
markdown
、
python-sphinx
、
restructuredtext
我找到了一个用例,除了从基于
的
文档
源生成和PDF之外,我还想生成源
文件
的
一个版本。 我
的
初步研究没有在狮身人面像中找到任何核心或扩展支持。除了手动使用或为任务创建一个新
的
Sphinx
扩展之外,是否有更简单/更集成
的
解决方案?
浏览 0
提问于2012-11-15
得票数 35
回答已采纳
2
回答
在
Sphinx
中使用autodoc时
的
标题
python
、
python-sphinx
、
restructuredtext
、
sections
、
autodoc
我有一个
文档
文件
,如下所示:H1H2Blah Blah == -- :members:"""========== """ 我
的
问题是,X.py
中
模块
文档
浏览 3
提问于2020-07-12
得票数 1
4
回答
警告:
文档
未包含在所包含
文件
的
任何目录树
中
python-sphinx
、
restructuredtext
、
toctree
我得到了警告:对于
文档
中
存在
的
文件
,因为它们已被显式包含。所以我有索引
文件
: :maxdepth: 2 pages/0020-bar 在
文件
0020-bar.rst
中
,我特别包含了许多其他
文件
reference-architecture/t
浏览 4
提问于2013-03-06
得票数 73
回答已采纳
7
回答
在狮身人面像中加入我
的
自述
python
、
markdown
、
python-sphinx
、
restructuredtext
我想将我
的
项目的README.md包含在我
的
狮身人面像
文档
中
--也就是说,在生成
的
Sphinx
文档
中
,我单击欢迎页面上目录
中
的
一个链接,然后进入README.md。为此,创建了一个包含以下行
的
文档
readme_link.rst----------- 我再加上一行 README
浏览 3
提问于2017-09-18
得票数 45
回答已采纳
2
回答
包括带有nbsphinx
的
笔记本失败
python
、
jupyter-notebook
、
jupyter
、
python-sphinx
、
toctree
我是
Sphinx
的
新手,我想编写Python包
的
文档
。当我想要包含一个演示
文件
时,我遇到了问题。extensions = [ '
sphin
浏览 0
提问于2019-03-22
得票数 0
4
回答
具有轻量级标记
的
Javascript API
文档
框架
javascript
、
markdown
、
python-sphinx
、
restructuredtext
、
jsdoc
我正在寻找一个Javascript API
文档
框架,具有类似于JSDoc
的
功能,但会在代码注释(而不是html)中使用易于键入
的
重构文本或标记。 额外好处:可以很好地与
Sphinx
集成。但是,我不想维护单独
的
文档
,而是从注释生成API
文档
。
浏览 0
提问于2011-08-12
得票数 5
回答已采纳
1
回答
狮身人面像
文档
和
Markdown
链接
python-3.x
、
markdown
、
python-sphinx
我正在尝试使用
Sphinx
从
Markdown
源代码构建一些
文档
。我
的
conf.py如下..。html输出生成,但是README.md在两个子目录中有指向其他标记
文档
的
链接,如以下....链接
的
...so与目录在侧栏
中
的
工作
浏览 0
提问于2018-09-20
得票数 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
回答
Weblate与Wiki.js和git
的
集成有多好?
python-sphinx
、
weblate
、
wiki.js
Weblate有关于"“
的
详细解释,目前我使用
的
是和Github。Weblate与Wiki.js集成得很好,但我更喜欢Weblate,这是一个开源
的
自托管应用程序。我喜欢Wiki.js
的
文件
和
文件
夹
结构
。Wiki.js有一个很好
的
内置编辑器,也可以存储md格式
的
文件
。虽然
Sphinx
与Weblate无缝集成,但我想知道
Sphinx
是否可以使用md
文件
而不
浏览 28
提问于2021-02-23
得票数 1
2
回答
Sphinx
无法识别我
的
降价表
markdown
、
python-sphinx
、
restructuredtext
我在本地使用带有.md
文件
的
sphinx
。当我以下面的格式添加一个表时:一|二|三===== ===== ========= ===== ====dfgvv dffffffff当我使用rst
文件
时,我收到关于错误
结构
的
表
的
错误消息,而在md<
浏览 3
提问于2017-06-09
得票数 10
1
回答
如何在pandoc中使用
sphinx
rtd主题
pandoc
我使用pandoc
将
markdown
文件
转换为html
文档
。我想知道是否可以
将
Sphinx
rtd theme用于使用pandoc转换后
的
html
文档
: pandoc mydoc.md -o mydoc.html 你能告诉我如何使用这个模板到我
的
html吗?
浏览 15
提问于2019-02-02
得票数 1
回答已采纳
1
回答
进入现有
文件
夹
git
我有一个Git存储库,在这里存储
Sphinx
文件
,并为单个
文档
构建。我希望将该
文档
中
的
一些
文件
(css、徽标等)重用到其他
文档
中
,并在理想情况下跟踪这些“核心
文件
”与其他
文档
(例如,rst)
的
更改。我认为这样做
的
一种方法是
将
“核心”
文件
分割成一个单独
的
Git存储库,但我很难找到一种
将
这些核心<
浏览 0
提问于2019-04-05
得票数 1
回答已采纳
1
回答
如何在标记
文件
中
为
Sphinx
使用automodule或autoclass?
python
、
python-sphinx
、
read-the-docs
、
autodoc
我理解狮身人面像支持可选
的
标记或.md
文件
,这对我
的
食物
文档
非常有用。我要做
的
是在一个标记
文件
中使用autoclass或automodule标记。通常,在.rst
文件
中
,如果我这样做了 :members: 它将自动提取所有的
文档
字符串并创建
文档
。在.md
文件
中
可以使用它吗?目前,当我尝试这样做时,生成<e
浏览 6
提问于2019-11-20
得票数 5
回答已采纳
2
回答
Python在生成pdf时跳过第一节
python
、
latex
、
python-sphinx
、
pdflatex
、
toctree
我使用sphynx从静态.rst
文件
生成
文档
(没有
文档
字符串提取)。我
的
存储库中有两个
文件
:.. toctree:: 和intro.rst=============== ============== 以下是通过运行
sphinx
-build -b latex ._build; cd _build; pdf
浏览 0
提问于2015-01-15
得票数 5
回答已采纳
6
回答
Python模块/包名称
的
Sphinx
apidoc节
标题
python
、
html
、
title
、
python-sphinx
、
api-doc
当我运行
sphinx
-apidoc,然后运行make html时,它会在目录(TOC)
中
的
每个模块/包名称
的
末尾生成“子包”和“子模块”部分以及“模块”和“包”
的
文档
页面。在不编辑
Sphinx
源代码
的
情况下,如何防止编写这些额外
的
标题
?下面是我想要制作
的
一个
文档
页面示例(注意TOC): 据我所知,这是由于
sphinx
源代码
中
的
浏览 2
提问于2014-01-08
得票数 18
回答已采纳
4
回答
到GitHub README.md
的
Python
python
、
markdown
、
restructuredtext
、
docstring
、
manpage
如何
将
Python
文档
字符串转换为GitHub readme.md
文件
?pydoc
的
输出是手册( Unix系统
的
groff格式)。对医学博士来说这是个死胡同不是一件事。通过HTML,pydoc3 -w + pandoc
将
文档
字符串完全咀嚼为位。自定义代码()似乎有很多简短
的
自定义代码,但对于我尝试过
的
少数代码,输出似乎不如那个具有摘要
的
pydoc,它添加了继承
的
方法,并列出了一些属性。 mkdocs
浏览 9
提问于2016-03-26
得票数 41
回答已采纳
1
回答
如何在DO2
中
启用减价支持并保留原始
文件
扩展名?
markdown
、
doxygen
我希望尽可能地保持代码中
文档
的
可读性,但我也希望使用DO2自动生成
文档
。我正在使用Ubuntu12.04和DOxy1.7。编辑1: “并保留原始
文件
扩展名”
添加到
浏览 1
提问于2013-10-30
得票数 0
回答已采纳
1
回答
交叉引用由Jupyter notebook
中
的
Sphinx
的
automodule指令生成
的
Python函数
python
、
jupyter-notebook
、
python-sphinx
、
autodoc
使用
Sphinx
's automodule指令,我从模块
中
的
所有函数各自
的
文档
字符串
中
为它们创建了一个API
文档
。相应
的
.rst
文件
仅由以下几行组成: API Reference.. automodule:: pkg_name.module_name :undoc-members: :show-inheritance: 我还使用nbSphinx
将</
浏览 23
提问于2021-03-23
得票数 0
2
回答
是否可以自动生成用于pytest测试
的
文档
?
pytest
、
python-sphinx
例如
结构
->├── __init__.py├── test_basic_auth_user.py assert response.request.headers["Auth"] == "Basic %s" % encoded 可以使用
Sphinx
从
文档
字符串自动生成
文档
吗?
浏览 4
提问于2019-11-15
得票数 1
点击加载更多
扫码
添加站长 进交流群
领取专属
10元无门槛券
手把手带您无忧上云
相关
资讯
如何使用 Python在30 分钟内快速搭建博客?
快速开发:用Python快速编写博客平台
用Python教你30分钟快速搭建自己的博客
用Python 30分钟教你快速搭建一个博客
在 Obsidian 中创建和使用链接 | Linux 中国
热门
标签
更多标签
活动推荐
运营活动
广告
关闭
领券