python-sphinx

0热度

1回答

我试图获得一些基本文档，以漂亮的在线格式发布on readthedocs。理想情况下，我希望侧边栏包含我的模块列表。我碰到this answer，这似乎解决了我的问题 - 但实施它完全没有。除此之外，我得到的印象是它不仅仅是模块（或者我试图重现的例子，genindex）列表没有被添加 - 而是相关列表甚至没有被构建。我基于这样一个事实，即http://labbookdb.readthedoc

0热度

1回答

狮身人面像添加背景图片

我是狮身人面像文档生成器的新手，我想添加一个背景图片到网站。我该如何处理？我试图把bg图像放到静态文件夹中，并尝试将它添加到css中，但它仍然没有出现。

0热度

1回答

sphinx：没有从docstring的内容更新HTML内容

我一直在努力与Senna交互，这是在使用Python的NLP处理中使用的工具。为了便于生成文档，我使用了reStructuredText文档样式，这非常简单。在调用make html，很少时间（并且有时没有警告）已经示出像pntl.tools.Annotator.test的文档字符串警告：2：警告：字段列表结束，而不一个空行意外的unindent和另外一件事情是什么是使用这个数字2在工作中显示

0热度

1回答

在狮身人面像输出中显示缩进

我正在尝试构建restructuredText文件，以便狮身人面像呈现html中的层次结构。我怎样才能建立RST格式来实现类似下面的打印输出：这 Is An Example output

2热度

2回答

参考图

目前我正在试图安装一个新结构化模板。我想包括编号的数字和参考。所以我也跟着狮身人面像文档（http://www.sphinx-doc.org/en/stable/markup/inline.html）中的说明。首先我包括线 numfig = True 在文件 'conf.py' 。我实现了这个数字，在我的文件“rstTemplate.rst”对它的引用如下： .. _my-figure:

7热度

1回答

的Python：文档字符串并键入注释

拥有像函数： def foo(x: int) -> float: return float(x) 我想用一个NumPy的类文档字符串类似如下： def foo(x: int) -> float: """ Parameters ---------- x Input parameter Returns ------

0热度

1回答

如何创建将不会出现在与狮身人面像toctree中的标题

我正在使用sphinx为python模块创建文档。我想在页面上添加字幕，但我不希望它们出现在toctree。我想要小节和简短的几行描述。将每个部分的标题添加到toctree将使浏览文档变得更加困难。这里是我的index.rst： Welcome to ModernGL's documentation! ==================================== .. fi

0热度

1回答

如何在使用动态类和动态模块时自动生成使用Sphinx的Python文档

我目前有一个用例，我使用下面的代码在模块中创建Python类。 ... module = type.ModuleType(module_name) ... klass = type(name, (object,), dict(__doc__='docstring')) ... setattr(module, name, klass) ... 但是Sphinx无法为这些类生成文档。它

1热度

1回答

选择性地禁用readthedocs语法突出显示

我有一个RST文件，我不希望任何语法突出显示。它包含多个文字块，并在文件顶部的一大亮点指令尝试禁用语法要点： .. highlight:: none :: Text that happens to contain words like list, None, etc. :: Another literal block with words like list, No

1热度

1回答

使用amp-img标记代替图像的img标记 - Sphinx

我正在创建基于加速移动页面（AMP）的Sphinx主题。创建它时，我意识到由于AMP使用amp-img标签代替img标签。有没有办法将狮身人面像生成的文档中的所有img标签转换为amp-img