为PyTorch创建脱机PDF文档时出错
我想在我的系统上为PyTorch文档创建一个脱机PDF。读取多个资源后#1、#2、#3 git clone https://github.com/pytorch/pytorch cd pytorch/docs/ make latexpdf 前两个命令运行正常。第三个命令会导致以下错误 Traceback (most recent call last): File "sour
..
python-sphinx相关内容
如何用狮身人面像自动对接装饰方法？
当我有一个具有如下定义的闭包的装饰符时： def Decorator(arg): class InnerDecorator: """Here i use the arg: {arg}""" __doc__ = __doc__.format(arg=arg) def __init__(self, func): s
..
狮身人面像：不同的相对路径可能通向同一个人物？
我是Sphinx新手，希望在两个不同的*.rst文件中显示相同的图形。 第一个*.rst文件"lower.rst"与“Figures”文件夹位于同一级别，我在其中包括了一个图形，如下所示： .. figure:: figures/figure1.png 第二个*.rst文件"higher.rst“，比lower.rst高几级。实际上，我将lower.rst包含在Higher.rst
..
如何将外部文件作为类似于代码块的Sphinx文档包含在内？
如何将外部文件作为类似于代码块的Sphinx文档包含？ 如何设置语法颜色的样式？ 推荐答案 找到：http://sphinx-doc.org/markup/code.html .. literalinclude :: :language:
..
在Sphinx中生成外部链接
我想链接到我的Sphinx文档中的一些URL： blah 我在文档中找到了类似的东西：http://sphinx-doc.org/ext/extlinks.html--但按照惯例，它更像是用链接替换自定义语法。相反，我只想生成指向外部Web资源的链接。 推荐答案 在reStructuredText documenta
..
在index.html页面上显示刚刚从内容表(Sphinx库)中选择的选项
我在使用Python中的Sphinx库时遇到了一个问题。 当用户从“内容：”表中选择一个选项时，所有文件内容都将显示在内容页上。 正如您所看到的，滚动条不在开头，而在中间，这表明页面包含以前的另一个内容。 如何配置Sphinx，这样通过从“Contents”中选择一个子菜单，它只显示其内容，而不是整个可用数据(Contents中的每个选项一个页面)？ 非常提前感谢您。 更新1： Index
..
Sphinx忽略以_in文件名开头的py文件
我正在使用test project中的Sphinx 4.4.0。我使用sphinx.ext.autodoc和sphinx-apidoc。 但并不是所有的py文件都能被识别。看起来文件名中以_开头的文件被忽略(例如_mypackage.py)。但我不确定是这个角色还是别的什么原因。 您是否知道有修改该行为的选项？ 这是项目结构 sphinx_versuch ├── docs │
..
狮身人面像不够自动化
我在一个大型的资源库中工作，其中有大约100个单独的文件夹，每个文件夹都有20-30个子文件夹，每个子文件夹都包含自己的.py文件夹。目前，我必须使用sphinx-apidoc命令为每个文件创建.rst文件，然后将路径添加到conf.py文件，然后将.rst文件添加到index.rst文件。有没有自动化的方法，这样只需几个命令就可以完成所有这些操作。 推荐答案 sphinx-autod
..
列表等数据结构类型的Sphinx文档字符串标准是什么？
Sphinx是否有用于记录不是简单的单个对象的参数或返回值类型的受支持标准？ 例如，在下面的代码中，arg1是一个str，arg2是一个str列表，arg3是一个str或int。如何在Sphinx中指定集合或复合类型？或者这方面没有共同的标准？ def function(arg1, arg2, arg3): """ :param arg1: Argument 1 :
..
避免来自父对象的文档字符串，在Sphinx中
我将Sphinx用于自动文档，但我发现它在默认情况下将父类docstring追加到我的文档字符串中的方式很烦人。 结果是，对于从unittest.TestCase继承的每个文档化测试类，我都会得到文档字符串“创建执行时将使用命名测试方法的类的实例。如果实例没有具有指定名称的方法，则引发ValueError。”。因此，这两句话一遍又一遍地散落在我的测试文档中。 如何阻止Sphinx从父级
..
Sphinx不识别子文件夹
我是新手Sphinx。只要我的文件在source顶层文件夹中，我就能够创建HTML文档。 只要我将它们放到source directory中的子文件夹中，Sphinx就不会将文档包含到构建中。Sphinx在生成后告诉我测试文档不包括在内。因此，它可以看到该文件，但不包括它。 我错过什么了吗？我是否必须在index.rst文件或config.py中指定任何子文件夹？ 我的index
..
为什么狮身人面像不能在这个Travis/Tox版本中找到这个包？
Travis内部版本：https://travis-ci.com/Laurentiu-Andronache/he/jobs/184044676 conf.py：https://github.com/Laurentiu-Andronache/he/blob/master/docs/source/conf.py tox.ini：https://github.com/Laurentiu-An
..
警告：点命令点不能运行
我正在为一个软件编写文档。并且我在我的REST文件中使用了GRAPRVIZ指令。 .. graphviz:: :align: center 但是，当我运行 制作html 即使在我的virtenv(OS-Mac)中安装了graph viz，我也收到了一个点命令的错误。我已将conf.py更新为扩展名‘sphinx.ext.graph viz’ 警告：点命令‘Dot’无
..
Sphinx HYPERLINK：打开反勾号前的非空格
如果紧接在开始反标记之前有‘/’字符或字母(如‘V’)，则不会检测到我的超链接。 是否有不引入空格的解决方法？ 推荐答案 在非空格字符和开始反标记之间转义一个空格字符，如下所示： v `Python `_ 将呈现为：
v
..
如何避免：隐藏：源文件被添加为Sphinx PDF生成的pdf文件中的书签
使用Sphinx文档生成器(使用pdflatex)，我正在创建pdf文件，并使用label和ref这样的标记添加了指向一些内部文件的链接： 在被调用文件(xyz.rst) .. _called-file-label: 在调用文件(abc.rst)中，我添加了对label的引用，如下所示： :ref:`Get Info ` 通过上面的安
..
作为构建命令的一部分，更改sphinx conf.py中的变量
我有一个带有conf.py的Sphinx项目，其中我使用一个变量来指定我的产品名称，如下所示： device_name = "ProductName" rst_epilog = f".. |device_name| replace:: {device_name}" 我希望能够在构建过程中将ProductName的值作为.bat文件的一部分进行修改，因为我正在构建同一项目两次，分别针对我
..
如何将自动模块添加到Sphinx Toctree
我希望Sphinx文档的左侧菜单包含项目的模块，并且希望从主模块的__init__.py文件定义此内容。这就是我正在尝试的： __init__.py ''' Components platform: -------------------- * language: python * rest framework: flask-restful * testing: pytest * docu
..
包括多个带有Sphinx和指令的RST文件。包括：：
在我的Sphinx项目中，我希望有一个包含多个RST文件的包含文件夹，以便在其他项目中重复使用。我的源文件夹类似于： source include links.rst # Here I have useful external links roles.rst # Here I define custom roles subs.
..
修复Sphinx RemovedInSphinx30警告
尝试使用Sphinx v2.1.2和sphinx-rtd-theme 0.4.3生成文档时收到两条警告消息。 第一个是： /docs/numsec.py:50: RemovedInSphinx30Warning: app.override_domain() is deprecated. Use app.add_domain() with override option instead.
..
左对齐Sphinx HTML输出中的所有数学块
我有通过the math directive包含数学块的Sphinx文档。默认情况下，它们在HTML输出中居中。我希望它们都显示为左侧对齐，但相对于周围文本有一些缩进。 例如，如果这在index.rst 中 For :math:`|r|
..