python-sphinx 相关问题

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

打印出Sphinx指令所在的方法/函数名称

我根据ToDo示例在pytest中为Sphinx文档创建了自己的扩展。这是从每个pytest test_function的每个文档字符串中读取和收集“test_summary”。 ...

python documentation pytest python-sphinx

回答 1 投票 0

如何为sphinx文档保留装饰类的文档字符串？

我有一个装饰器，它有一个包装类的嵌套定义。包装器将其包装的原始类维护为属性。玩具示例如下所示：def decorator（cls）：class ...

python python-sphinx python-decorators docstring

回答 1 投票 3

托管私人Sphinx文档[关闭]

我目前正在使用Sphinx为一个相当复杂的Django网站编写一些大量文档。我一直在内部工作，在我很快离开之前，我想留下详细的......

django python-sphinx

回答 2 投票 16

Sphinx与Django - Model没有声明一个明确的应用程序标签

我花了无数个小时，但这仍然停滞不前。文档非常缺乏。使用Django 1.10，尝试创建已经出现各种错误的Sphinx文档。最后我被卡住了......

python django python-2.7 python-sphinx

回答 2 投票 1

狮身人面像：“没有模块命名”

我正在尝试使用Sphinx为我的Python / Flask应用程序构建文档，但是我无法导入该文件。我在views.rst上导入views.py文件，但出现一条错误消息：没有模块...

python python-sphinx

回答 1 投票 0

在Google风格的Python文档字符串中“写”？

在Google风格的Python文档字符串中，可以按如下方式指定Args，Returns，Raises。 “”这是Google风格的一个例子.Args：param1：这是第一个参数.param2：这是第二个......

python python-sphinx

回答 1 投票 1

Python-Sphinx：用自定义页面替换标准首页

我很高兴探索Sphinx的功能，到目前为止看起来都很好。我现在要做的是用一些来自...的命令替换首页的标准乳胶格式。

formatting latex python-sphinx

回答 1 投票 0

如何根据Sphinx上的'.. http'指令创建目录（sphinxcontrib.httpdomain）？

我想基于sphinxcontrib.httpdomain的http指令为我的页面创建一个目录，这是Sphinx的扩展。我的“部分”是“定义”的.. http：get :: / user，.. http：post：...

python python-3.x python-sphinx

回答 1 投票 0

使用现有项目设置Sphinx Autodoc

我是Sphinx的新手并且已经看过几个小时的教程，但找不到我的问题的答案我有一个当前的项目结构，如下面的-project文件夹| -sub文件夹1 | ...

python-sphinx autodoc sphinx-apidoc

回答 1 投票 0

我可以使用sphinx自动模块但是在签名中删除模块名称吗？

我有一个带有一些submodule submod的模块mod，并使用.. automodule :: mod.submod为它生成文档。模块中的元素（函数，类等）的签名现在看起来......

documentation python-sphinx

回答 1 投票 0

如何测试Sphinx文档的有效性？

我有一大堆使用标准Sphinx .rst文件编写的Python包文档。我也有测试我的包，其中我想包括一个测试是否...

python testing python-sphinx

回答 1 投票 4

Python Sphinx中的RTL支持

有没有办法在狮身人面像中使用RTL（从右到左，如波斯语，阿拉伯语......）文本？从.rst文件生成html时，生成的html是LTR（默认情况下从左到右）并向左对齐，我的......

html documentation python-sphinx

回答 3 投票 10

错误“表格主体没有剩余数据，”list-table“指令要求。”同时自动生成Flask应用程序的Sphinx文档

我有这样的Flask webservice：来自flask导入Flask，jsonify app = Flask（__ name__）@ app.route（'/ api / ping'）def ping（）：“”“检查服务是否还活着..：：quickref：平;得到乒乓......

python flask python-sphinx

回答 1 投票 0

Sphinx文档：conf.py变量的翻译（i18n）

在sphinx文档项目中，如何将翻译添加到conf.py中定义的变量中？例证：项目变量是“ 设置和配置手册“，我...

python internationalization python-sphinx

回答 1 投票 0

readthedocs如何在没有conf.py的情况下从RST生成Sphinx HTML？

我正在考虑对github和readthedocs上托管的现有项目进行更改。但是，生成的HTML看起来是由Sphinx构建的，没有conf.py. $ ls appendixA.rst chapter11.rst ...

python-sphinx read-the-docs

回答 1 投票 0

在mathjax_config中添加自定义乳胶宏

我正在尝试添加一个新的期望运算符宏，以便在某些文档字符串中使用。如果在数学部分我做：.. math :: \ newcommand {\ EE} [2] [] {\ mathbb {E} _ {＃1} \ left [＃2 \ right]} \ EE {2 + 4 } ...

python latex python-sphinx mathjax

回答 1 投票 1

在ReStructuredText中加粗斜体

我正在使用ReStructuredText（ReST）格式编写一些文档，以便稍后使用Sphinx生成网页，我找不到编写一些“粗体斜体”文本的方法。有标记...

documentation python-sphinx restructuredtext

回答 3 投票 37

找不到“sphinx-build”命令。

这是我们安装Sphinx的过程。 > choco 安装 python -y -f > pip 安装狮身人面像我们知道 sphinx 安装是因为以下输出。 > 点显示狮身人面像 --- 元...

python windows-10 python-sphinx chocolatey

回答 8 投票 0

我在阅读文档时遇到了项目问题

用sphinx-quickstart创建了狮身人面像项目。跑“制作HTML”并没有产生错误。将所有代码推送到GitHub。我尝试在Read the Docs上导入和构建项目，但得到以下内容......

documentation python-sphinx

回答 1 投票 1

使用Sphinx ImageMagick扩展名sphinx.ext.imgconverter更改已转换图像的分辨率

我们正在使用Python-Sphinx来构建我们的最终用户手册。为了自动转换我们的各种图形文件格式，就像我们使用的是Sphinx Extension sphinx.ext.imgconverter，...

pdf svg imagemagick latex python-sphinx

回答 1 投票 0

python-sphinx 相关问题

最新问题