External hyperlink produces garbled HTML when end of URL happens to overlap with name of identifier
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.5k
- Forks
- 228
- PR merge metrics
- No merged PRs in 30d
Description
Problem Description
pdoc produces incorrect HTML when trying to link to a URL whenever the end of the URL happens to be a . followed by any identifier that appears in the project. This results in HTML that displays incorrectly and links to the wrong place. This seems to happen regardless of whether the link is written via Markdown syntax or reStructuredText syntax.
Steps to reproduce the behavior:
- Create
issue/__init__.pylike this:def com(): """ [something](https://example.com) """ pass - Run
pdoc issueto generate documentation - Observe the generated documentation for the
comfunction. It produces HTML that looks like this:
which visually renders as:<a href="https://example<a href=" #com"="">.com</a>">something
where the.com">something.comtext seems to link to the invalid URLhttps://example<a href=.
System Information
pdoc: 15.0.4
Python: 3.11.12
Platform: macOS-15.3.1-arm64-arm-64bit
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running the reported pdoc issue reproduction and compare the generated HTML with the expected external link. Trace how the Markdown and reStructuredText hyperlink forms are processed, then verify that URLs ending in .com are preserved as external links without identifier linking or malformed HTML.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 66/100