Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sphinx is not rendering enum members #162

Open
mattsb42-aws opened this issue Jun 21, 2019 · 3 comments
Open

sphinx is not rendering enum members #162

mattsb42-aws opened this issue Jun 21, 2019 · 3 comments

Comments

@mattsb42-aws
Copy link
Member

This worked originally; at some point it changed.

sphinx-doc/sphinx#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".

@bpeake-illuscio
Copy link

To tack onto this: If you have defined any methods on the enum class, they are not being printed either.

@karlw00t
Copy link
Contributor

Thanks for the details! We'll look into it.

@mattsb42-aws
Copy link
Member Author

mattsb42-aws commented Nov 12, 2019

Experimenting with this on another project, I found that the missing syntax is the members and undoc-members values.

.. automodule:: aws_encryption_sdk.identifiers
   :members:
   :undoc-members:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants