-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Open
Labels
Description
Describe the bug
Im doing a big project where I am generating html files from the docstrings using .rst
files.
Everything is working nicely except that no "free" function appears in the documentation, the docstring is there and it appears in the .pyi
file. When using vscode, this function that does not appear in the documentation shows the docstring when I hover over it.

The rest of the API appears perfectly: classes, enums...
It works if I use directly:
.. autofunction:: doocs4py.get
How to Reproduce
In the main .rst
Members
----------
.. automodule:: doocs4py
:imported-members:
:members:
:undoc-members:
:show-inheritance:
:no-index:
The stub in the .pyi
def get(address: Address, input: Data | None = None) -> Data:
"""
get(address: Address, input: Data | None = None) -> Data
Perform a get-call over the network.
The get call sends a data object and an address object to the device and reads back
a data object. The data sent to the device is only useful for some properties
to specify a time range or to select a stored spectrum for instance.
Parameters
----------
address : Address | str
Control system address.
input : Data, optional
Data object with data that will be sent to the remote server.
Returns
-------
Data
Data object containing the response from the remote server.
Raises
------
ErrorCode
If the call returns an error code.
"""
Environment Information
Platform: linux; (Linux-6.8.0-64-generic-x86_64-with-glibc2.39)
Python version: 3.12.3 (main, Jun 18 2025, 17:59:45) [GCC 13.3.0])
Python implementation: CPython
Sphinx version: 8.2.3
Docutils version: 0.21.2
Jinja2 version: 3.1.6
Pygments version: 2.19.2
Sphinx extensions
extensions = [
'sphinx.ext.mathjax',
'sphinx.ext.autodoc',
'sphinx.ext.autosectionlabel',
'sphinx.ext.napoleon'
]
Additional context
No response