sphinx-doc/sphinx

Partial functions are not documented when the original function comes from a different module

Open

#8,550 创建于 2020年12月17日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Python (1,985 fork)batch import
extensions:autodochelp wantedtype:bug

仓库指标

Star
 (5,625 star)
PR 合并指标
 (平均合并 10天 11小时) (30 天内合并 11 个 PR)

描述

Describe the bug When using autodoc, partial functions do not appear in the HTML output if the original function (used to create the new partial function) comes from a different module.

To Reproduce Steps to reproduce the behavior:

$ git clone https://github.com/scganterh/sphinx_bug_partial_functions.git
$ cd sphinx_bug_partial_functions
$ pip install sphinx
$ make html
$ # open html/b.html and see that no documentation for the `b` function is generated.

Expected behavior I expect to see the documentation for b.b generated the same way as the documentation for b.d.

Your project https://github.com/scganterh/sphinx_bug_partial_functions

Screenshots image You can see there is no entry for b.b.

Environment info

  • OS: Linux
  • Python version: 3.6.2
  • Sphinx version: 3.3.1
  • Sphinx extensions: sphinx.ext.autodoc
  • Extra tools: Browser

贡献者指南