DOC: Fix invalid Sphinx cross-references in older whatsnew RST files#64459
Open
DOC: Fix invalid Sphinx cross-references in older whatsnew RST files#64459
Conversation
Co-authored-by: mroeschke <10647082+mroeschke@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix incorrect Sphinx cross references in documentation
DOC: Fix invalid Sphinx cross-references in older whatsnew RST files
Mar 7, 2026
Member
|
/preview |
Contributor
|
Website preview of this PR available at: https://pandas.pydata.org/preview/pandas-dev/pandas/64459/ |
mroeschke
reviewed
Mar 7, 2026
doc/source/whatsnew/v0.18.0.rst
Outdated
Comment on lines
+821
to
+822
| performed with the ``Resampler`` objects with :meth:`~pandas.core.resample.Resampler.bfill`, | ||
| :meth:`~pandas.core.resample.Resampler.ffill`, ``fillna`` and :meth:`~pandas.core.resample.Resampler.asfreq` methods. |
Member
There was a problem hiding this comment.
@copilot change the module paths to reference pandas.api.typing instead of pandas.core.resample
Author
There was a problem hiding this comment.
Updated in 0c5480e — the Resampler method references now use pandas.api.typing.Resampler instead of pandas.core.resample.Resampler.
Co-authored-by: mroeschke <10647082+mroeschke@users.noreply.github.com>
Member
|
/preview |
Contributor
|
Website preview of this PR available at: https://pandas.pydata.org/preview/pandas-dev/pandas/64459/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Running
sphinx-buildwithnitpicky = Trueproduces warnings for broken cross-references in whatsnew files for versions 0.13–0.19, where referenced objects have since been renamed, moved, or removed.Changes
For each broken reference, either correct it to point to the current documented API or replace with double-backtick literals when no valid target exists.
Corrected to valid references
~pandas.io.json.json_normalize→:func:pandas.json_normalize`` (v0.13.0)~pandas.io.parsers.ParserWarning→:class:pandas.errors.ParserWarning`` (v0.14.0)boxplot→:func:pandas.plotting.boxplot`` (v0.14.0)~pandas.io.read_sas(meth) →:func:pandas.read_sas`` (v0.17.0)~Resampler.ffill/backfill/asfreq(wrong module context) → fullpandas.api.typing.Resampler.*paths;backfillcorrected tobfill(v0.18.0)union_categoricals→:func:pandas.api.types.union_categoricals`` (v0.19.0):func:datetime.datetime→ `:class:`python:datetime.datetime(v0.19.0)Replaced with backtick literals (objects removed/not in any intersphinx target)
Panel.apply,Panel.shift,Panel.major_xs,Panel.minor_xs— Panel removed (v0.13.1,v0.14.0)create_engine,parallel_coordinates,andrews_curves,DateRange,HDFStore.select_column,Timestamp.offset,get_data_yahoo,get_data_google,rolling_sum/max/min(v0.14.0)rolling_*,expanding_*,ewm*top-level function references;describe,set_names,set_labels,set_levels(v0.15.0)io.wb.download(v0.15.1),SparseSeries.to_coo/from_coo(v0.16.0),pandas.io.gbq.to_gbq(v0.17.0,v0.17.1),py._path.local.LocalPath(v0.17.1),Resampler.fillna(v0.18.0),union_categorical,read_gbq,to_gbq,Panel4D.to_xarray(v0.19.0)Original prompt
This section details on the original issue you should resolve
<issue_title>DOC: Fix incorrect Sphinx cross references in older, whatsnew restructred text files.</issue_title>
<issue_description>The top level
doc/directory contains reStructuredText files who's names will end in.rstand are used to build the pandas documentation using Sphinx. These files can contain Sphinx cross-referencing syntax to create a link to where the reference is documented. Specifically, the Python cross-referencing syntax is used. Cross references should reference currently documented pandas objects or objects in other libaries specified in theintersphinx_mappingvariable indoc/source/conf.pyWhen
sphinx-buildcommand is run withnitpicky = Trueset in thedoc/source/conf.py, the logs will specify the file location, line number, and invalid cross references. Below is a subset of invalid cross references from older whatsnew files