mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Fix #7331: autodoc: a cython-function is not recognized as a function
This commit is contained in:
parent
5138255665
commit
5c396b6325
1
CHANGES
1
CHANGES
@ -132,6 +132,7 @@ Bugs fixed
|
|||||||
* #7267: autodoc: error message for invalid directive options has wrong location
|
* #7267: autodoc: error message for invalid directive options has wrong location
|
||||||
* #7329: autodoc: info-field-list is wrongly generated from type hints into the
|
* #7329: autodoc: info-field-list is wrongly generated from type hints into the
|
||||||
class description even if ``autoclass_content='class'`` set
|
class description even if ``autoclass_content='class'`` set
|
||||||
|
* #7331: autodoc: a cython-function is not recognized as a function
|
||||||
* #5637: inheritance_diagram: Incorrect handling of nested class names
|
* #5637: inheritance_diagram: Incorrect handling of nested class names
|
||||||
* #7139: ``code-block:: guess`` does not work
|
* #7139: ``code-block:: guess`` does not work
|
||||||
* #7325: html: source_suffix containing dot leads to wrong source link
|
* #7325: html: source_suffix containing dot leads to wrong source link
|
||||||
|
1
setup.py
1
setup.py
@ -52,6 +52,7 @@ extras_require = {
|
|||||||
'pytest-cov',
|
'pytest-cov',
|
||||||
'html5lib',
|
'html5lib',
|
||||||
'typed_ast', # for py35-37
|
'typed_ast', # for py35-37
|
||||||
|
'cython',
|
||||||
],
|
],
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1011,7 +1011,8 @@ class FunctionDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter): # typ
|
|||||||
if self.env.config.autodoc_typehints in ('none', 'description'):
|
if self.env.config.autodoc_typehints in ('none', 'description'):
|
||||||
kwargs.setdefault('show_annotation', False)
|
kwargs.setdefault('show_annotation', False)
|
||||||
|
|
||||||
if inspect.isbuiltin(self.object) or inspect.ismethoddescriptor(self.object):
|
if ((inspect.isbuiltin(self.object) or inspect.ismethoddescriptor(self.object)) and
|
||||||
|
not inspect.is_cython_function_or_method(self.object)):
|
||||||
# cannot introspect arguments of a C function or method
|
# cannot introspect arguments of a C function or method
|
||||||
return None
|
return None
|
||||||
try:
|
try:
|
||||||
|
4
tests/roots/test-ext-autodoc/target/cython.pyx
Normal file
4
tests/roots/test-ext-autodoc/target/cython.pyx
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
# cython: binding=True
|
||||||
|
|
||||||
|
def foo(*args, **kwargs):
|
||||||
|
"""Docstring."""
|
@ -22,6 +22,13 @@ from sphinx.testing.util import SphinxTestApp, Struct # NOQA
|
|||||||
from sphinx.util import logging
|
from sphinx.util import logging
|
||||||
from sphinx.util.docutils import LoggingReporter
|
from sphinx.util.docutils import LoggingReporter
|
||||||
|
|
||||||
|
try:
|
||||||
|
# Enable pyximport to test cython module
|
||||||
|
import pyximport
|
||||||
|
pyximport.install()
|
||||||
|
except ImportError:
|
||||||
|
pyximport = None
|
||||||
|
|
||||||
app = None
|
app = None
|
||||||
|
|
||||||
|
|
||||||
@ -1609,3 +1616,22 @@ def test_singledispatchmethod():
|
|||||||
' A method for general use.',
|
' A method for general use.',
|
||||||
'',
|
'',
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.usefixtures('setup_test')
|
||||||
|
@pytest.mark.skipif(pyximport is None, reason='cython is not installed')
|
||||||
|
def test_cython():
|
||||||
|
options = {"members": None,
|
||||||
|
"undoc-members": None}
|
||||||
|
actual = do_autodoc(app, 'module', 'target.cython', options)
|
||||||
|
assert list(actual) == [
|
||||||
|
'',
|
||||||
|
'.. py:module:: target.cython',
|
||||||
|
'',
|
||||||
|
'',
|
||||||
|
'.. py:function:: foo(*args, **kwargs)',
|
||||||
|
' :module: target.cython',
|
||||||
|
'',
|
||||||
|
' Docstring.',
|
||||||
|
'',
|
||||||
|
]
|
||||||
|
Loading…
Reference in New Issue
Block a user