python-sphinx

1热度

1回答

假设我有以下结构的项目： mypackage ├── mypackage │ ├── __init__.py │ ├── someclass.py │ └── somefunction.py └── setup.py 然后，我有__init__.py为： from mypackage.someclass import someclass from mypackage.somefun

1热度

2回答

狮身人面像RTD主题和新线

我已经在Python 3书面图书馆和记录类，它的方法，常量的过程现在等我有是常数微妙的格式问题列表或字典。我的组织已经采取了列举和类型的字典应该在可读性以下格式写入的位置... my_list = [ 'One', 'Two', 'Three', ] my_dict = { 'One': 1, 'Two': 2, 'Three':

0热度

3回答

使用狮身人面像自动生成每个功能

我已经建立了许多不同功能的Python模块一个单独的文件。我正在使用Sphinx和readthedocs来提供文档。我取得了不错的进展，但目前我有one massive page，它提供了我所有功能（按字母顺序）的文档。我看过其他项目，每个功能都有单独的页面。在查看源代码时，我发现为每个文件创建了一个单独的.rst文件。我认为这是自动完成的，关于生成自动数据摘要的this page看起来好像描

0热度

1回答

Sphinx csv-table指令产生错误的列数

我有这个简单的csv-table应该产生一个只有两行和两列的表。相反，它给了我三栏，最后一栏是空的。为什么？ .. csv-table:: "Inline :math:`a^2+b^2=c^2`","Seperate: .. math:: (a + b)^2 = a^2 + 2ab + b^2 (a-b)^2 = a^2-2ab+b^2

1热度

1回答

是否可以在ReST文字块中插入超链接？

我知道这种失败的文字块的目的，但我想知道是否有任何解决方法来实现这一目标。我的用例是将超链接放在伪代码的块字面中，以便引用文档中其他地方的详细信息。实施例： Look at this JSON pseudo code ----------------------------- :: { "id": <number>, "name": <string>,

0热度

1回答

使用Sphinx Autodoc时模拟内部模块

我的python包有一个名为settings.py的模块，它查找settings.ini文件，如果找不到，则引发异常。我的软件包工作正常，但是当我尝试使用Sphinx Autodoc时，它失败了，因为它无法找到设置文件。我有什么选择来解决这个问题？我能想到的是把一个settings.ini文件放在其中一个Sphinx目录中，以便它可以被读取。如果可能，以某种方式模拟内部设置模块。该设置模块

1热度

1回答

如何将一个子目录及其内容包含到Sphinx输出/构建目录中？

我的Sphinx项目有以下目录结构。根构建源 index.md 片段我想按原样复制root/source/snippets至build/html/snippets;这个目录有代码片段文件。我不认为.. include::,:download:和html_extra_path是我所需要的。有没有办法使用构建配置来做到这一点？或者是修改make构建脚本的唯一方法。我使用Python v2.

12热度

2回答

如何使用Sphinx显示与文本相符的键盘按键图片？

在我的Sphinx文档中，当我在重构的文本中引用它们时，我想显示键盘按键的图片。例如，如果我说：点击Enter键。我想显示一个Enter键的图片，而不是Enter一词。我在许多教程中看到过这种图形，用于指键盘按键，菜单选项等。他们如何做到这一点？狮身人面像有可能做到这一点吗？

1热度

2回答

sphinx_rtd_theme未在ReadTheDocs版本上应用，但本地版本正常工作

我正面临一个奇怪的问题。我将最新的sphinx_rtd_theme文件添加到我的项目中，并完成了所需的主题覆盖（包括表格中众所周知的文字换行）。本地构建工作绝对好。但它被推到了主人手中，这个主题回到了非常基本的层面，并没有得到应用。我尝试了手动构建，但仍无法追查根本原因和解决方法。通过主人，我的意思是在ReadTheDocs网站（帐户）上创建的版本。

0热度

1回答

狮身人面像，打造

我可以给你的狮身人面像型动物index1.rst作为参数来构建../build/html_1/和index2.rst建立../build/html_2/：我sphinx-build文档发现如何定义目标文件夹，但没有指定有关index.rst文件