prestodb/presto

Sphinx 8 will drop support for representing paths as strings. Use "pathlib.Path" or "os.fspath" instead.

Open

#22475 opened on Apr 10, 2024

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Java (15,558 stars) (5,240 forks)batch import
beginner-taskbootcampcleanupdocsgood first issue

Description

Warning in build

/Users/elharo/presto/presto-docs/presto-docs-venv/lib/python3.9/site-packages/sphinx_material/init.py:74: RemovedInSphinx80Warning: Sphinx 8 will drop support for representing paths as strings. Use "pathlib.Path" or "os.fspath" instead. filename = app.outdir + "/sitemap.xml" Generating sitemap for 483 pages in /Users/elharo/presto/presto-docs/target/html/sitemap.xml build succeeded, 738 warnings.

Contributor guide

Tech stack
pythonshell
Domain
documentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue is a deprecation warning from Sphinx 8 about representing paths as strings. The specific file is sphinx material/ init .py at line 74, where 'filename = app.outdir + "/sitemap.xml"' is used. Replace this with pathlib.Path usage: 'from pathlib import Path; filename = Path(app.outdir) / "sitemap.xml"'. Check for similar patterns in the same file or other files in the repository to ensure consistency. The fix is localized and well documented, making it ideal for a first time contributor.