草庐IT

sphinx-build

全部标签

python - "Failed building wheel for psycopg2"- MacOSX 使用 virtualenv 和 pip

我第一次尝试与其他几个人一起创建一个网站,但在尝试使用Django/Python/VirtualEnv时遇到了一个奇怪的错误。我已经为其他操作系统(例如Ubuntu)找到了此问题的解决方案,但找不到适用于Mac的任何好的解决方案。这是正在运行的相关代码:virtualenv-ppython3venvsourcevenv/bin/activatepipinstall-rrequirements.txt运行该block后,我收到以下错误:AssertionErrorFailedbuildingwheelfordjango-toolbeltRunningsetup.pybdist_wheel

python - 如何使用 Python 以编程方式生成 Sphinx 文档的一部分?

我正在使用Sphinx为我的一个项目生成文档。在这个项目中,我在yaml中描述了可用命令的列表。文件,一旦加载,就会生成{command-name:command-description}形式的字典,例如:commands={"copy":"Copythehighlightedtextintheclipboard","paste":"Pastetheclipboardtexttocursorlocation",...}我想知道的是如果sphinx中有方法在makehtml循环中加载yaml文件,在一些reStructuredText格式(例如definitionlist)并包含在我的h

python - 如何在 Sphinx 文档中创建内部超链接

这个问题在这里已经有了答案:Addingacross-referencetoasubheadingoranchorinanotherpage(6个回答)关闭去年。如何在Sphinx文档中创建内部超链接?我正在使用::role:`target`但它不起作用。 最佳答案 交叉引用是使用ref:ref:`label-name`您可以使用以下方式提供标签:.._label-name:见:https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-re

Python Sphinx autodoc 和装饰成员

我正在尝试使用Sphinx来记录我的Python类。我使用自动文档这样做:..autoclass::Bus:members:虽然它正确地为我的方法获取文档字符串,但那些被修饰的方法:@checkStaledefopen(self):"""Somedocs."""#Code@checkStale存在defcheckStale(f):@wraps(f)defnewf(self,*args,**kwargs):ifself._stale:raiseExceptionreturnf(self,*args,**kwargs)returnnewf有一个不正确的原型(prototype),例如ope

python - 使用 len() 和 def __len__(self) : to build a class

只是好奇,在构建类时使用len()或def__len__()有什么区别(优点和缺点)?哪种Python风格最好?classfoo(object):def__init__(self,obs=[])self.data=obsself.max=max(obs)self.min=min(obs)self.len=len(obs)或classfoo(object):def__init__(self,obs=[])self.data=obsself.max=max(obs)self.min=min(obs)def__len__(self):returnlen(self.data)

python - Sphinx 和 argparse - 自动记录命令行脚本?

我正在构建一个Python包,并使用Sphinx创建文档。除了我的包代码之外,我还包含了许多使用argparse的命令行Python脚本。我想知道是否有办法让Sphinx自动记录这些脚本?最终目标将是一个pretty-print的脚本列表,以及相关的帮助打印、参数和选项。需要明确的是,我正在寻找一种预先存在的方法来执行此操作,而不是自己实现此操作的方法。这并不像我通常在S.O.上问的那样具体,如果有更合适的S.E.发布此问题的网站,请告诉我。 最佳答案 使用sphinx-argparse扩展:http://sphinx-argpar

python - 如何在 Sphinx 文档和 nbsphinx 中嵌入 Plotly 图

我尝试使用nbsphinx嵌入一个包含绘图的Jupyter笔记本,但这些绘图没有显示在文档中,即使它们在Jupyter笔记本上看起来不错。如何在Sphinx中嵌入绘图图documentation?我可以将它们包含为图像,但有更好的方法吗?有互动就好了!我想做的是复制thispage.它具有Jupyter笔记本风格的进出block,并显示使用plotly制作的交互式绘图。我该怎么做?GitHub问题提出here. 最佳答案 我可以看到两种解决方案,可以在sphinx文档中嵌入带有plotly图形的笔记本单元格。使用nbconvert或

python - 如何将本地目录包含到 Sphinx 文档中?

如何将本地目录包含到Sphinx文档中?我试过了..toc::但这似乎没有任何效果:文档中没有插入任何内容。基本上,我需要将指向当前页面中各个部分的链接放置在每个页面的特定位置。这可能吗? 最佳答案 我不能100%确定这是您要查找的内容,但..contents::指令可能会有所帮助。默认情况下,无论您将指令放在何处,它都会为您提供整个页面的标题。指定:local:后,它将为您放置指令的下面的标题生成一个本地TOC(对于小节目录很方便)。..contents::TableofContents:depth:3更多详情:http://do

python - Anaconda 4.7.5 - 关于 conda-build <3.18.3 和 python 包问题的警告

我在UbuntuLinux18.04LTSx64上运行Anacondapython发行版,并使用通常的condaupdate--all更新了发行版。之后,命令行消息建议更新conda基本默认值。现在由于某种原因,我遇到了几个问题。首先,即使尝试重新安装condainstalljupyter,我也无法启动jupyterlab。其次,我收到了这条新警告信息。WARNINGconda.base.context:use_only_tar_bz2(632):Condaisconstrainedtoonlyusingtheold.tar.bz2fileformatbecauseyouhavecon

python - 有没有人使用 Sphinx 来记录 C++ 项目?

就目前而言,这个问题不适合我们的问答形式。我们希望答案得到事实、引用资料或专业知识的支持,但这个问题可能会引发辩论、争论、投票或扩展讨论。如果您觉得这个问题可以改进并可能重新打开,visitthehelpcenter寻求指导。关闭9年前。Sphinx是一个新的Python文档工具。它看起来非常漂亮。我想知道的是:这对于记录C++项目有多合适?是否有任何工具可以将现有文档(例如doxygen)转换为Sphinx格式?是否有使用Sphinx的C++项目的在线/可下载示例?使用过Sphinx的人有什么建议吗? 最佳答案 如前所述here和