aws / aws/aws-encryption-sdk-python

Sphinx does not follow paths for class aliases for parameter types

未关闭
#61 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
good first issue help wanted maintenance
主要语言
Python
星标
255
派生
92
平均合并
2 天 17 小时
30 天内合并 PR
2

描述

## 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`.

贡献指南

打开贡献指南

调研方向

检查 src/aws_encryption_sdk/__init__.py 第 72-73 行中的别名定义,然后将生成的加密文档与其源链接进行比较。跟踪生成参数类型链接的 Sphinx 模块,并验证参数引用解析为 AlgorithmSuite,而不是未知类。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
缺陷
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。