Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 task done
hwhsu1231 opened this issue Nov 27, 2024 · 0 comments
Open
1 task done
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member

Comments

@hwhsu1231
Copy link

hwhsu1231 commented Nov 27, 2024

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

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
@hwhsu1231 hwhsu1231 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member
Projects
None yet
Development

No branches or pull requests

1 participant