如何在嵌套目录中生成sphinx停靠点?

2023-11-29

我想从嵌套文件夹结构中的脚本生成 sphinx autodoc 文档:

└── programs
    └── general_name
        └── another_folder
            ├── script1.py
            └── script2.py

由于某种原因, script1.py 和 script2.py 未与自动文档一起显示,我只能看到脚本名称:

programs.general_name.another_folder package

¶Submodules

programs.general_name.another_folder.script1 module
programs.general_name.another_folder.script2 module

完整文件夹结构:

../
├── docs
│   ├── _build
│   │   ├── doctrees
│   │   │   ├── environment.pickle
│   │   │   ├── index.doctree
│   │   │   └── rst
│   │   └── html
│   │       ├── genindex.html
│   │       ├── index.html
│   │       ├── objects.inv
│   │       ├── rst
│   │       ├── search.html
│   │       ├── searchindex.js
│   │       ├── _sources
│   │       └── _static
│   ├── conf.py
│   ├── index.rst
│   ├── make.bat
│   ├── Makefile
│   ├── rst
│   │   ├── modules.rst
│   │   ├── programs.general_name.another_folder.rst
│   │   ├── programs.general_name.rst
│   │   └── programs.rst
│   ├── _static
│   └── _templates
└── programs
    └── general_name
        └── another_folder
            ├── script1.py
            └── script2.py

我正在运行这个命令:

/docs $ sphinx-apidoc -f -o rst/ ../programs/ && make html

我也尝试过:

$ sphinx-apidoc -f -o rst/ ../programs/general_name/another_folder/ && make html

但是script1模块和script2模块在生成html文件时是空的。

解决方案:

找到导致问题的原因 - 破折号“-”。 another_folder 实际上被命名为 get_requests_from_server-10

将文件夹重命名为 get_requests_from_server_10 后,自动停靠开始工作


根据文档sphinx-apidoc:

sphinx-apidoc 是一个自动生成 Sphinx 源代码的工具,它使用 autodoc 扩展来记录整个 Sphinx 源代码package与其他自动 API 文档工具的风格相同。

源目录必须指向一个Python包.

(强调已添加)

根据这个所以答案:

任何Python文件都是module,其名称是文件的基本名称,不带.py扩大。 Apackage是 Python 模块的集合:模块是单个 Python 文件,而包是包含附加内容的 Python 模块的目录__init__.py文件,以区分包和恰好包含一堆 Python 脚本的目录。

首先添加一个空的__init__.py每一个sourcedir,看看是否可以解决问题。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

如何在嵌套目录中生成sphinx停靠点? 的相关文章

随机推荐

  • python 3.6 与旧版本中的字典顺序

    当我运行它时 我需要按照这个确切的顺序打印这段代码 访客团队 访客评分 主队 主评分 预期获胜者 利润 tabulate final dict Visitor Team visitor team Visitor Rating visitor
  • document.getElements() 支持

    document getElements 函数的支持程度如何 此外 是否有一个 javascript 参考页面 其中包含详细的浏览器支持信息 我通常使用 mozilla 文档 但我想知道是否有更好的东西 我实际上找不到有关 document
  • 防止为类或模块创建新属性

    我在SO上看到这个问题防止在外部创建新属性init它展示了如何防止向类的对象添加新属性 我希望整个类甚至整个加载的模块具有相同的行为 示例类 class Klass a 0 b 1 另一个模块 from Klass import Klass
  • 如何在Python中制作可点击的图像

    我是 python 图像编程的初学者 如果我单击图像 我需要显示您单击的图像 1 像那样 到目前为止我尝试过的内容附在下面 始终显示 img 1 img 1 img 1 但不起作用 from tkinter import from tkin
  • 从mysql数据库获取带有unix时间戳的最近30分钟的记录

    我想从 mysql 数据库的表中获取数据 其中我的时间戳为 unix 格式 我在做了一些研究后使用了以下查询 但仍然无法获得结果 它显示空行 谁能帮忙 SELECT FROM bs items WHERE owner id 3 AND ti
  • 有关于 NHibernate 与 Fluent NHibernate 启动性能的数据吗?

    简而言之 什么方法效果更快 SessionFactory 预编译 XML 配置 或 流畅的 NHibernate 提供 以编程方式配置 我个人的经验是 配置对象的构建 无论是否使用 Fluent 这是不可避免的 通常会使设置 FluentC
  • 目标属性必须是依赖属性 - 为什么?

    我知道依赖属性在 WPF 中起着主要作用 但是 我不明白在绑定中目标属性必须是依赖属性这一限制背后的原因 为什么不能是任何财产 如果您有兴趣 可以打开 Reflector 并查看一些与框架中的依赖属性和绑定系统相关的代码 为了实现属性路径的
  • 将 9 补丁图像添加到 Android Studio

    我使用以下命令创建了一个九补丁图像简单的九补丁生成器 这将创建一个目录res folder 包含图像的每个像素密度版本的文件夹 In Eclipse with ADT人们可以简单地将这些文件夹拖放到res 您的项目的文件夹 这看起来很简单
  • 正在链接... LINK:致命错误 LNK1181:无法打开输入文件“libgsl.a”

    我正在使用 SIFT 算法代码Rob Hess它在 Windows 中使用 OpenCV 库 我使用 Visual Studio 2008 作为 IDE 当我在 VS 中运行具有 调试 作为解决方案配置的图像匹配程序时 没有问题 一切正常
  • 为什么初始 CSS 样式在 DOM element.style 字段上不可见?

    好吧 我完全期待着因为问一些愚蠢的事情 或者至少重复 而陷入困境 但在所附的片段中 为什么我必须使用window getComputedStyle访问 CSS 应用的样式 我的印象是 style字段至少会反映 CSS 最初应用的样式和 或此
  • 如何使用 python 检索弹性搜索中某个术语的频率?

    我必须找到该术语在所有包含该术语的匹配文档中出现的频率 例如 天空 例如 如果 doc1 有一个句子 天是蓝的 天是蓝的 doc2 有一句话 飞机在天上飞 那么术语 天空 的总频率应该是 3 我发现术语向量如下所述 https www el
  • java mp3 输入流到字节数组?

    在你说 谷歌它 之前 我尝试过 发现了一些有趣的文章 但没有任何效果 我需要将 mp3 文件从网站转换为字节流 稍后可以将其保存到本地文件中 这是我的代码 最重要的部分 Url url new Url someUrl URLConnecti
  • Excel图表动态范围选择

    我有一个客户对 Excel 工作表设置有一个简单但复杂的请求 但我不知道从哪里开始 我正在画一个空白 我们有一个数据范围 例子 Quarter Data 2010Q1 1 2010Q2 3 2010Q3 4 2010Q4 1 我在此基础上建
  • 如何从android中的线程中获取结果?

    我有一个主类 一个工作线程类 它们是分开的 在主线程中 我将输入传递给工作线程并要求它工作 完成后 我希望它将结果发送回主线程 我怎样才能做到这一点 public class MainActivity extends Activity Ha
  • 限制对特定邮箱的域范围委派

    我一直在开发服务器到服务器的谷歌日历集成 通过它连接 读取和写入用户的日历 这工作得很好 但是我有一个关于权限范围的问题 使用具有域范围委派的服务帐户 这意味着该帐户可以访问组织中从 CEO 到我的每个用户的日历 有没有办法从 Google
  • 定义 JavaScript 事件对象

    为什么我会收到这段代码的错误 function catchevent eventSrcID event srcElement event srcElement id undefined eventtype event type status
  • 反向 Ajax + JSP-Servlet

    我们正在尝试在我们的项目中创建一个反向ajax 我在网上查了一下 没有找到具体的东西 我无法成功运行任何提供的教程 我的目标是 当服务器有偶数推送时 可能是高 CPU 使用率 RAM 等 提供屏幕警报 如弹出窗口 HTTP 协议 毕竟幸运的
  • 适用于多个 IDP 的 Spring SAML 扩展

    我们计划在我们的应用程序中使用 spring saml 扩展作为 SP 但我们的应用程序的要求是我们需要与 1 个以上的 IDP 进行通信 任何人都可以向我提供 指导我使用多个 IDP 的示例吗 我还想知道 spring saml 扩展支持
  • 将 Karma-runner 与 AngularJS、Jasmine、CoffeeScript 结合使用

    我的应用程序除了jRuby Rails uses AngularJS CoffeScript 我想测试我的javascriptJasmine并运行它Karma aka Testacular 但我收到一条错误消息 指出我的Angular 模块
  • 如何在嵌套目录中生成sphinx停靠点?

    我想从嵌套文件夹结构中的脚本生成 sphinx autodoc 文档 programs general name another folder script1 py script2 py 由于某种原因 script1 py 和 script