aws / aws/aws-encryption-sdk-python

sphinx is not rendering enum members

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

Description

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".

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the linked Sphinx issue #1609 and the repository's auto-generated documentation tree. Determine where enum members are expected to appear and whether the current documentation structure can support the change; done means enum members render correctly without relying on an unstructured generated dump.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.