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

Update the templates and sphinx version. #193

Merged
merged 2 commits into from
Feb 6, 2023
Merged

Conversation

Revathyvenugopal162
Copy link
Contributor

Fix #186

@github-actions github-actions bot added maintenance Generic maintenance related bug Defects or glitches reported by users or developers labels Feb 3, 2023
Comment on lines -29 to -31
{% if item.0 != item.upper().0 %}
{{ name }}.{{ item }}
{% endif %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Revathyvenugopal162 Did you check that it fixed the enum issue in some local documentation without any (obvious) side effects?
I think it should be all good.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good point, @MaxJPRey.

Copy link
Contributor Author

@Revathyvenugopal162 Revathyvenugopal162 Feb 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked, and earlier the autosummary will not render the attributes in uppercase, and now it will support both upper and lower case( especially with enum-class members.)

Before

image

Rendered new docs.

enum_new

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, PyDF-composite is using the same behavior now.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect. Thanks @Revathyvenugopal162 .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Defects or glitches reported by users or developers maintenance Generic maintenance related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enum values are not being documented with autosummary
3 participants