Sphinx autodoc 模拟导入导致未记录的 object

Question

I am trying to document constants derived from mocked imports (foo.FOO)

foo.py

"""Foo module."""


from asdf import qwerty


FOO = qwerty.FOO
"""Foo constant."""


ASDF = 1
"""ASDF."""


def foo():
    """Return foo :py:const:`foo.FOO` :py:const:`foo.ASDF`."""
    return FOO

conf.py

import os
import sys
sys.path.insert(0, os.path.abspath(os.pardir))

project = 'sphinx'
copyright = '2021, sphinx'
author = 'sphinx'

extensions = ['sphinx.ext.autodoc']
templates_path = ['_templates']
exclude_patterns = []
html_theme = 'alabaster'
html_static_path = ['_static']

autodoc_mock_imports = ['asdf']
nitpicky = True

#nitpick_ignore = [
#    ('py:class', 'foo.FOO'),
#]

When I run make html SPHINXOPTS=-Ea I get the resulting documentation.

But I would expect that when I mock the import that foo.FOO is documented (see picture above).

Sphinx: 4.3.0

Is this a feature or a Bug?

Answer 1

This was actually a bug and has been fixed https://github.com/sphinx-doc/sphinx/pull/9905