-
-
Notifications
You must be signed in to change notification settings - Fork 19.6k
Open
Open
Copy link
Labels
Description
Pandas version checks
- I have checked that the issue still exists on the latest versions of the docs on
mainhere
Location of the documentation
https://pandas.pydata.org/docs/dev/reference/aliases.html
Documentation problem
Trying to link to the type aliases with Sphinx 9’s :type: role doesn’t work.
That’s because you don’t have them in your intersphinx inventory at all. In #61735, you added (failing) references to them instead of using directives to define reference targets for them:
pandas/doc/source/reference/aliases.rst
Lines 28 to 34 in 961357c
| ==================================== ================================================================ | |
| Alias Meaning | |
| ==================================== ================================================================ | |
| :py:type:`AggFuncType` Type of functions that can be passed to :meth:`agg` methods | |
| :py:type:`AlignJoin` Argument type for ``join`` in :meth:`DataFrame.join` | |
| :py:type:`AnyAll` Argument type for ``how`` in :meth:`dropna` | |
| :py:type:`AnyArrayLike` Used to represent :class:`ExtensionArray`, ``numpy`` arrays, :class:`Index` and :class:`Series` |
Suggested fix for documentation
This should instead be something like:
.. py:type:: AggFuncTypeor, to insert docstrings automatically:
.. autotype:: AggFuncTypealso that page uses .. currentmodule:: instead of .. module:: for similar effect.