python-sphinx 相关问题

Sphinx是一种工具,可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档,但它是一个通用工具,可用于记录任何内容。

重组文本(Sphinx):用文件名替代吗?

我想从一个模板创建多个文件,这些文件的区别仅在于变量名。例如:(file1.rst):.. | variable |替换:: 1 .. include template.rst(template.rst):变量| ...

回答 2 投票 15

sphinx-如何包括Python函数作为源代码

Sphinx非常适合链接到特定的Python对象。例如,编写:func:`foo.bar`将直接链接到foo.py中的bar函数。我想要相同的功能,但不是...

回答 1 投票 0

更一致的Sphinx主题

考虑mymodule.py中的以下功能#:def myfunc(num,mystring):“”“复制一个字符串:param num:一个正整数:param mystring:一个字符串:return:string ...

回答 1 投票 2

Sphinx latexpdf忽略文件的一部分

使用Latexpdf构建pdf时,Sphinx是否可以忽略index.rst的一部分?例如,我的index.rst文件包含(但不以).. image行:https:// img ....

回答 1 投票 0

sphinx自动功能在本地但在服务器上无法正常工作

该自动功能在我的本地计算机上运行完美,但是在服务器上它什么也没有显示。我检查日志并找到以下内容,警告:autodoc:无法导入功能blablabla; ...

回答 1 投票 0

诗歌+狮身人面像+ Cython

我用诗歌来制作我的cython软件包。我在所有函数和类中都有NumPy样式的文档字符串。我现在想要做的是添加Sphinx自动文档并在“阅读文档”中发布。 ...

回答 1 投票 1

带有狮身人面像的文档PyCharm项目的问题

我想为我的pycharm项目制作文档。我在项目目录(“模型”)中创建了一个目录docs。我安装了sphinx,并使用sphinx-quickstart制作了所有必需的文件。然后我...

回答 1 投票 0

尝试在某些GIMP Python插件代码上运行Sphinx时出错

我正在尝试使用Sphinx记录一个Python文件,该文件用于实现GIMP插件。问题是,当我跑步时;使html我得到以下消息-如下所示,...

回答 1 投票 1

Python-sphinx:忽略.rst文件中的文本

我在GitHub上有一个README.rst,该文件也已合并到Sphinx生成的Python项目文档中。我想在文件顶部添加一个注释,该注释将显示在GitHub ...

回答 1 投票 2

Python的狮身人面像include指令:忽略从包含的文件头

我发现..包括::指令的文本再利用是非常有用的:同样的部分可以在不同的文件中插入。但与头水平的问题。举例来说,如果我有part.rst与...

回答 1 投票 0

如何在标题中打印文档版本?

我刚刚使用带有雪花石膏主题的sphinx-quickstart.exe创建了一个Sphinx文档。我想在标题的某个位置打印文档的版本。我填写了版本并发布了变量...

回答 2 投票 1

声明在扩展额外的依赖性狮身人面像建造

TL,DR:从狮身人面像的扩展,我怎么告诉狮身人面像建造对待一个额外的文件作为依赖?在我立即使用的情况下,这是扩展的源代码,但问题同样可以...

回答 1 投票 0

狮身人面像:如何设定访问链接的颜色(sphinx_rtd_theme)

我目前正在创建使用sphinx_rtd_theme一个狮身人面像的文档。我想知道如何改变已访问链接的颜色。到目前为止,我只找到使用经典主题(可能性...

回答 1 投票 0

将狮身人面像与Markdown结合使用,而不是RST

我讨厌RST,但喜欢狮身人面像。有没有一种方法可以让狮身人面像读取markdown而不是reStructuredText?

回答 10 投票 209

如何创建新结构化/狮身人面像漂浮的数字?

我想有文字缠着一个数字。这是我在说什么:可选附件的安装==================================== ..警告::切勿插入或拔出手...

回答 4 投票 8

更改Sphinx阅读文档主题的图标?

我已经使用自定义css使用def setup(app)覆盖主题的一些样式:app.add_css_file('custom.css')这很好用。还有什么其他应用功能可用吗?我不能......

回答 1 投票 3

Sphix中的分层文档

我正在尝试在Sphinx中生成分层文档。我想要以下结构:简介快速启动Weather API(一个通用页面+2个子页面)温度湿度...

回答 1 投票 0

什么是sphinx默认模板?

有一个可以覆盖的layout.html模板。还有更多吧?它们是什么,我在哪里可以找到原始代码?我想看看默认模板是什么样的,所以我可以......

回答 1 投票 0

使用lua过滤器迭代表行的问题

我正在尝试为pandoc写一个简单的lua过滤器,以便对ReST表中的元素进行一些宏扩展。 filter.lua函数tablelength(T)本地计数= 0,成对_(T)...

回答 2 投票 3

Sphinx autodoc show-inheritance:如何跳过无证的中间基础?

我有一个这样的三层类结构:class Super(object):“”“这个类是记录的。”“”类中级(超级):传递类Sub(中级):“”“这也是......

回答 1 投票 9

© www.soinside.com 2019 - 2024. All rights reserved.