aws / aws/aws-encryption-sdk-python

sphinx is not rendering enum members

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

描述

This worked originally; at some point it changed.

https://github.com/sphinx-doc/sphinx/issues/1609

I tried just slotting this into our auto-generated tree, but it looks like this will only work once we re-structure the docs to be better organized and less reliant on "just auto-generate everything and dump it in a big pile".

贡献指南

打开贡献指南

调研方向

首先检查链接的 Sphinx issue #1609 和仓库的自动生成文档树。确定 enum 成员应显示在哪里,以及当前的文档结构是否能够支持此更改;完成的标准是 enum 成员能够正确渲染,而不依赖无结构的生成 dump。

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

评估

技术栈
python
领域
documentation
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

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