个人中心
文章发布
退出
作者热门文章
- c - 在位数组中找到第一个零
- linux - Unix 显示有关匹配两种模式之一的文件的信息
- 正则表达式替换多个文件
- linux - 隐藏来自 xtrace 的命令
24
4
我正在尝试仅对选定的模块使用 autodoc。我创建了一个文件，其中包括:
.. automodule:: some.specific.module
:members:
它会正确生成。不幸的是，autodoc 也一直在尝试解析其他文件(并且由于导入错误而失败)。我知道我可以模拟一些模块，但我想要一个更好的解决方案 - 从一开始就阻止 sphinx 查看它们。
我如何确保只加载请求的模块，而不是(例如)test.other.module。
最佳答案
结果证明这是一个愚蠢的错误。由于某些工具会为 api 文档源生成脚手架，因此这些文件被遗弃并触发了错误的导入。
这是如何发现的:
[autodoc] /path/to/the/doc.rst:158: input:
.. automodule:: app.module.name
:members:
关于python - 忽略 autodoc 中的一些模块，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/34409256/
24
4
0
我写了一个 python 类，并用 sphinx 制作了文档。例如，类看起来像: class Aclass(object): """ my class """ def __init__
我正在尝试使用 sphinx 来为我的项目创建文档，它是一组划分为项目内部模块的函数。 我只需要在文档中公开一小部分函数，所以我使用 autodoc-skip-member 通过标记文档字符串来过
我正在尝试使用 Sphinx 记录一个项目，但遇到了一个问题，即仅从文件夹中导入了一些模块。我的项目结构如下所示: Project | |--Main | |--Scripts |
我正在尝试自动生成我的 Django 项目的文档。文档树在 html 页面上生成，但我的任何模块中的任何成员都没有文档。我一直遇到这个问题: Running Sphinx v1.1.3 loading
我有一个 python 模块，它定义了一个多行字符串常量。我想在基于 Sphinx 的文档中很好地显示多行字符串。 下面是一些 Python 代码示例，RST 以及它如何使用 sphinx-build
正如标题所示，我正在使用 Sphinx 为 python 库生成文档并使用自动文档功能。 我遇到的问题是 autodoc 导入器无法正确导入库。 Traceback (most recent call
当我制作htmlthis little project的Sphinx文档时我得到: $ make html sphinx-build -b html -d _build/doctrees . _b
我是 sphinx 的新手，需要帮助来弄清楚为什么我会收到以下错误: WARNING: autodoc: failed to import module 'employe_dao' from modu
我正在尝试在 Sphinx 中使用 autodoc 打印出特定模块中每个函数的文档字符串，但不包括模块的文档字符串。可能吗？ 原因是我正在使用模块文档字符串来指定命令行选项(使用可爱的 docopt)
我正在尝试使用 sphinx(结合 autodoc 和 numpydoc)来记录我的模块，但是在基本设置之后，运行 make html 只生成基本的 html，不包含文档字符串。我运行的是Python
我正在尝试仅对选定的模块使用 autodoc。我创建了一个文件，其中包括: .. automodule:: some.specific.module :members: 它会正确生成。不幸的是，
我正在用 Sphinx 记录一个类，只是想跳过其中一个类成员: class StatusUpdateAdapter(logging.LoggerAdapter): """ """
我正在使用 Sphinx 的 autodoc 插件来自动记录一组模块。我有一个接受 *args 的函数，我想覆盖文档以显示更好的 funcname(arg1[, arg2[, ...]]) Pytho
我正在尝试使用 Sphinx 来记录我的 Python 类。我使用自动文档这样做: .. autoclass:: Bus :members: 虽然它正确地为我的方法获取文档字符串，但那些被修饰的
我有一个包含两个记录在案的全局特殊成员的模块。 在本地运行 Sphinx 会创建包含其文档的文档，但 Read the Docs 不会。它改为使用内置类型的文档。 我尝试了两种样式:#: 和定义后的文
我正在尝试使用 Sphinx 在 Python 中记录一个超过 5,000 行的项目。它有大约 7 个基本模块。据我所知，为了使用 autodoc，我需要为项目中的每个文件编写这样的代码: .. au
我正在使用 Sphinx autodoc 扩展来记录我的 Python 项目。我的类(class)文档中有以下内容: .. automodule:: ClassName :members:
我正在尝试在扩展外部类的类上运行 autodoc。 我使用了模拟以便接受导入。 为此，我使用了此博客中描述的内容 http://blog.rtwilson.com/how-to-make-your-s
我有一个带有类型提示的长签名函数，例如 def set_parameters( tokenizer: Union[None, "Tokenizer", str] = None,
是否可以更改 Sphinx AutoDoc 生成的输出顺序？ 特别是，我使用 :private-members: 指令包括私有(private)成员。我想要的是私有(private)成员在输出中出现
我是一名优秀的程序员,十分优秀！