(apiref): links within the Python API Reference aren't being generated properly
- Dominant language
- TypeScript
- Stars
- 12.9k
- Forks
- 4.6k
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 83
Description
### Describe the issue
Links within the Python API reference are being generated as e.g. `[@link EbsDeviceVolumeType.GP2}` (where the text `@link` is a hyperlink that goes to `mailto:link@` rather than an HTML link to the desired page.
Example showing this: https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_ec2/BlockDeviceVolume.html?highlight=ebs#aws_cdk.aws_ec2.BlockDeviceVolume.ebs
But it's all throughout the Python API Reference.
### Links
https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_ec2/BlockDeviceVolume.html?highlight=ebs#aws_cdk.aws_ec2.BlockDeviceVolume.ebs
Contributor guide
Research direction
Start by tracing the generator that produces the Python API Reference, using the linked BlockDeviceVolume example as the reproduction case. Check how inline @link text is converted in the generated HTML and verify the result across other Python API reference pages. Done means these references render as links to their intended API pages rather than mailto:link@ URLs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100