aws / aws/aws-encryption-sdk-python

Sphinx does not follow paths for class aliases for parameter types

Open
#61 2 comments 0 reactions 0 assignees View on GitHub
good first issue help wanted maintenance
Dominant language
Python
Stars
255
Forks
92
Avg merge
2d 17h
Merged PRs (30d)
2

Description

## Problem
Even though `Algorithm` is an alias for `AlgorithmSuite`, it looks like the sphinx module that generates code links for parameter types doesn't realize that and just treats it as an unknown class.

ex:

render:

https://aws-encryption-sdk-python.readthedocs.io/en/latest/generated/aws_encryption_sdk.html#aws_encryption_sdk.encrypt

src:

https://github.com/aws/aws-encryption-sdk-python/blob/master/src/aws_encryption_sdk/__init__.py#L72-L73

## Solution
Replace parameter type references with `AlgorithmSuite`.

Contributor guide

Open the contributing guide

Research direction

Inspect the alias definitions in src/aws_encryption_sdk/__init__.py at lines 72-73, then compare the generated encrypt documentation with its source link. Trace the Sphinx module that generates parameter-type links and verify that the parameter reference resolves to AlgorithmSuite rather than an unknown class.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.