piskvorky/gensim

Broken documentation links on Gensim's PyPI page

Open

#3452 opened on Mar 8, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (15,144 stars) (4,349 forks)batch import
bugdifficulty easydocumentationgood first issueimpact LOWreach LOW

Description

Links in the Documentation section of our official PyPI page are broken (return 404): https://pypi.org/project/gensim/#documentation-1

OTOH, links at https://github.com/RaRe-Technologies/gensim#documentation work, so it looks like the PyPI version contains obsolete links that got out of sync.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic PythonGit/GitHubPyPI metadata
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
Locate the source file that defines the PyPI project description, likely `setup.py` or `README.rst`. Update the broken documentation links in that file to match the working links from the GitHub repository (e.g., https://github.com/RaRe Technologies/gensim#documentation). Verify the fix by running `python setup.py check restructuredtext` or a local build, and ensure the links resolve correctly.