DOC: Missing 'pickleshare' package when running 'sphinx-build' command

[hwhsu1231]

Pandas version checks

• I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

pandas/requirements-dev.txt

Line 26 in 106f33c

ipython

Documentation problem

After installing requirements-dev.txt and pandas from sources, I tried to run sphinx-build command to build pandas docs. However, I noticed that there are lots of such warnings:

UserWarning: This is now an optional IPython functionality, using bookmarks requires you to install the `pickleshare` library.
  bkms = self.shell.db.get('bookmarks',{})
UsageError: %bookmark -d: Can't delete bookmark 'ipy_savedir'

The followings are the commands I used:

git clone --branch=main https://github.com/pandas-dev/pandas.git pandas-main
cd pandas-main
git log -1 --pretty=format:"%H%n%s"
conda create --prefix ./.venv --channel conda-forge --yes
conda activate ./.venv
conda install python=3.10 --yes
export PYTHONNOUSERSITE=1
python -m pip install --requirement=requirements-dev.txt --progress-bar=off --verbose
python -m pip install . --no-build-isolation --no-deps -Csetup-args=--werror --progress-bar=off --verbose
export LANG=en_US.UTF-8
sphinx-build -b html -v -j 4 -c doc/source doc/source doc/build/html

Log file of the above commands:

log-sphinx-build-pandas-docs.txt

Suggested fix for documentation

It seems that this issue is caused by ipython/ipython#14237. Therefore, my suggested fix is to add pickleshare requirement in environment.yml and requirements-dev.txt.

Just like NumPy demonstrated here: requirements/doc_requirements.txt#L12-L14

Versions and Platforms

• OS version: Kubuntu 24.04
• Current Branch: main
• Latest Commit: 106f33c
• Conda version: 24.9.2
• Python version: 3.10.15
• iPython version: 8.29.0

[rhshadrach]

Thanks for the report, PRs to fix are welcome!

[lfffkh]

take

[hwhsu1231]

Will PR #60468 be backported to as many previous versions as possible?

Suppose that those PRs merged into the default branch are backported to branches like 2.2.x, 2.1.x, 2.0.x,...etc. Will tags be added for those backports? (For example, v2.0.3 -> v2.0.4)

Simply curious about the project management policy of pandas.

[rhshadrach]

In only truly exceptional circumstances will we backport beyond the last minor version (2.2 right now). For this, I do not believe we will backport at all, this only impacts development of pandas.