如何使用Sphinx记录简单的Python脚本？ - python

我已经阅读了许多Sphinx教程，但是我仍然不知道如何使Sphinx文档成为像这样的简单Python脚本：

def addNumbers(a):
    """This function adds one to the given number.

    :param a: The name to use
    :type a: int

    """
    b = a + 1
    print b

addNumbers(5)

以下是我要做的步骤。我想念什么？

安装Sphinx：

pip install sphinx

在我的项目目录中创建一个文档目录：

mkdir docs

从新的sphinx-quickstart目录内部运行doc，然后按Enter键以回答除以下两个问题以外的所有问题：

Separate source and build directories (y/n) [n]: y
autodoc: automatically insert docstrings from modules (y/n) [n]: y

这使我的项目目录结构变为：

myproject/ 
|-- docs/
    |-- build/
    |-- source/
    make.bat
    Makefile
|-- mycode/ 
    myscript.py 

打开conf.py，取消注释以下几行，并添加我的代码所在的文件夹的路径：

import os
import sys
sys.path.insert(0, os.path.abspath('C:\myproject\mycode'))

从我的docs目录运行以下命令：

make html

这给了我以下确认，没有错误：

现在，当我打开C：\ myproject \ docs \ build \ html \ index.html时，仅看到以下内容，而没有原始文档中插入的文档字符串的信息。单击“模块索引”会显示“找不到文件”错误。这是为什么？

编辑：
完成上述所有步骤之后，我添加了一个文件夹mypackage，并在其中复制了包含我的代码的文件，使目录内容如下所示：

myproject/ 
|-- docs/
    |-- build/
    |-- source/
    make.bat
    Makefile
|-- mycode/ 
    myscript.py 
|-- mypackage/ 
    myscript.py 

然后，我从doc目录运行以下命令：

sphinx-apidoc -f -o source/ ../mypackage/
make html

现在，单击“模块索引”可以看到以下内容：

然后单击myscript给出以下内容：

现在的问题是，为什么我的主脚本myscript.py列在模块下而不是文档首页上？

参考方案

要使Python将目录视为包含软件包，需要一个__init__.py文件。请参见Python tutorial documentation of packages。

我的猜测是sphinx-apidoc会将您的脚本识别为脚本，而不是程序包，因为您省略了__init__.py文件。根据sphinx-apidoc的文档：

sourcedir必须指向Python包。

在文档下方也有一个警告：

如果您记录脚本（相对于库模块），请确保其主例程受if __name__ == '__main__'条件保护。

在没有看到您的代码的情况下，我将从__init__.py文件开始，看看是否可以解决它。

Python GPU资源利用 - python

我有一个Python脚本在某些深度学习模型上运行推理。有什么办法可以找出GPU资源的利用率水平？例如，使用着色器，float16乘法器等。我似乎在网上找不到太多有关这些GPU资源的文档。谢谢！ 参考方案 您可以尝试在像Renderdoc这样的GPU分析器中运行pyxthon应用程序。它将分析您的跑步情况。您将能够获得有关已使用资源，已用缓冲区，不同渲染状态上…

在返回'Response'(Python)中传递多个参数 - python

我在Angular工作，正在使用Http请求和响应。是否可以在“响应”中发送多个参数。角度文件：this.http.get("api/agent/applicationaware").subscribe((data:any)... python文件：def get(request): ... return Response(seriali…

Python sqlite3数据库已锁定 - python

我在Windows上使用Python 3和sqlite3。我正在开发一个使用数据库存储联系人的小型应用程序。我注意到，如果应用程序被强制关闭（通过错误或通过任务管理器结束），则会收到sqlite3错误（sqlite3.OperationalError：数据库已锁定）。我想这是因为在应用程序关闭之前，我没有正确关闭数据库连接。我已经试过了： connectio…

R'relaimpo'软件包的Python端口 - python

我需要计算Lindeman-Merenda-Gold（LMG）分数，以进行回归分析。我发现R语言的relaimpo包下有该文件。不幸的是，我对R没有任何经验。我检查了互联网，但找不到。这个程序包有python端口吗？如果不存在，是否可以通过python使用该包？ python参考方案 最近，我遇到了pingouin库。

Python-crontab模块 - python

我正在尝试在Linux OS（CentOS 7）上使用Python-crontab模块我的配置文件如下：{ "ossConfigurationData": { "work1": [ { "cronInterval": "0 0 0 1 1 ?", "attribute&…