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

Group module attributes/constants in separate summary table #280

Closed
sammorley-short opened this issue Apr 8, 2021 · 0 comments · Fixed by #281
Closed

Group module attributes/constants in separate summary table #280

sammorley-short opened this issue Apr 8, 2021 · 0 comments · Fixed by #281

Comments

@sammorley-short
Copy link

sammorley-short commented Apr 8, 2021

Currently documented module constants/attributes are listed with their values, but there is no summary table displayed. It would be great if a summary table could be added to these.

I believe this is because these constants/attributes exist in visible_children here, but there is no associated summary table generated by the template. I couldn't work out exactly how module attributes are identified and classified under the hood, but if they are, then it seems like one could simply define visible_attributes by filtering from visible_children and then adding the following section to the template:

{% block functions scoped %}
{% if visible_attributes %}
Attributes
~~~~~~~~~

.. autoapisummary::

{% for attribute in visible_attributes %}
   {{ attribute.id }}
{% endfor %}


{% endif %}
{% endblock %}

If that diagnosis and solution is correct, then I could take a pass at implementing this and submit it via a PR. But since I am unfamiliar with what's going on under the hood here I am unsure if this would actually work.

P.s. great package btw. Thanks for all the hard work 👌 👌 👌

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

Successfully merging a pull request may close this issue.

1 participant