问题标签 [autodoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
python - 使用 Sphinx 记录时省略（或格式化）变量的值
我目前正在用autodoc. 但是，我在模块级别定义了几个包含长列表或字典的变量。它们与值一起包含在文档中，并且值未格式化，因此看起来像 10 行混乱。我想要的是包含这些变量的文档字符串，但要省略这些值或至少格式化得很好。
我试图从automodule指令中排除变量并像这样添加它：
这导致仅包含变量名称，而文档字符串和值longstuff都没有出现在文档中。
如何保留文档字符串并同时删除该值（或将其格式化）？
python - 自动类和实例属性
根据sphinx 文档，该.. autoattribute指令应该能够记录实例属性。但是，如果我这样做::
然后在构建时我得到一个 AttributeError：
即使我实例化ElementTree并尝试访问该_root属性，它也可以正常工作::
我究竟做错了什么？
（我实际上在我自己的一个类中遇到了这个问题，但我只是以 ElementTree 类为例，因为它在标准库中）
python - Sphinx autodoc 给出警告：py:class reference target not found: type warning
我有一些在 python 中使用元类的代码。但是当 sphinx autodoc 运行时，它会给出错误：
WARNING: py:class reference target not found: type
错误发生在自动生成的 .rst 文件的一行中：
并且 blockList 扩展了已\__metaclass__设置为我的元类的 API.list.list。
据我所知，sphinx 认为内置类型类不存在。我尝试导入内置类型以使 sphinx 意识到它的存在，但没有奏效。
如果我从 API.list.list 中删除元类分配，并从代码中删除元类，那么 sphinx 就可以正常工作。
python - 将 f2py 扩展名导入为“import mymod.foo”
我从 Fortran 文件创建了一个 Python 模块：
file1.f90包含 Fortran 模块：foo, bar, bar. 模块foo包含函数：f, g, h.
f2py 自动为 function 编写文档字符串f。
mymod.so包含在目录ROOT中，我已经添加ROOT到我的PYTHONPATH.
我可以通过以下方式访问f函数的文档字符串：
我现在想f使用 sphinx 的 autodoc 扩展为函数编写文档：
但它失败了：
我认为 sphinx 正试图像这样导入，但它不起作用：
我试图导入一个包含__init__.py.
我怎样才能让 sphinx 找到mymod.foo.fdocstring？
python - 如何在 Sphinx 中的方法内自动添加函数
代码示例：
我试过：
但它不起作用。
有什么方法可以doc_b为我生成吗？
python - 覆盖 sphinx 的 autodoc 中的函数声明
我有一个类似这样的模块：
...我有一个.rst文件是这样的：
当我构建文档时，我得到一个带有如下代码段的 html 文件：
我的模块.foobar。foobar = '这里有一些荒谬的长而丑陋的正则表达式'
这里有额外的文档
我的模块。myfunc ( val='这里有一些又长又丑的正则表达式' )
等等等等等等
基于this stackoverflow post，我认为可以通过将模块更改为：
...但这并没有奏效，只是将我想要的签名附加在丑陋的签名下面作为身体的一部分。有人知道我如何正确地覆盖它吗？
（我正在使用 Sphinx v1.1.3，顺便说一句。）
emacs - 在 slime-autodoc 中：进程过滤器中的错误：错误的类型参数：sequencep，：not-available
当我使用 slime-repl 时，我在我的 minibuffer 中收到这条消息，并且 emacs 会挂起一秒钟：
进程过滤器中的错误：错误的类型参数：sequencep，：不可用
当我关闭 slime-autodoc-mode 时它停止发生
有人见过吗？
python - 带有 Django 1.4 的 Sphinx 自动文档
我在为 Django 1.4.1 项目构建模块自动文档时遇到问题。 make html似乎无法阅读我的文档字符串，因为它在导入我的设置时遇到了麻烦。我见过的所有在线指南都建议使用
但这在 1.4 中已被弃用，并且该settings.configure()方法似乎不合适。我还没有找到关于如何在 1.4 中运行的信息。我尝试设置DJANGO_SETTINGS，但没有运气。有什么建议么？
python - 如何在 Sphinx 中定义应该使用哪些 .rst 文件和目录？
如何在 Sphinx 中定义应该使用哪些 .rst 文件和目录？
我想在我的测试/构建/文档脚本中包含一个自动文档生成器。 sphinx-quickstart在我的工作区中执行并创建了一个 index.rst 文件。由于 Sphinx 使用重组的文本文件作为文档，我在工作区中导航并使用sphinx-autogen手动创建它们。它导致了 tasks.rst 文件（见下文）。
当我使用“make html”时，会收到几个警告：
警告：自动模块的签名无效（u'tasks/add_to_config'）
警告：autodoc 无法导入/查找模块 'tasks.add_to_config'，它报告错误：“没有名为 wl_build.tasks 的模块”，请检查您的拼写和 sys.path
警告：不知道要导入哪个模块来自动记录 u'tasks/add_to_config'（尝试在文档中放置“模块”或“当前模块”指令，或给出明确的模块名称）
...
我的索引.rst
任务.rst