Skip to content

Commit

Permalink
Don't generate docs for derived properties for enums
Browse files Browse the repository at this point in the history
  • Loading branch information
janvonrickenbach committed May 10, 2024
1 parent e7a7c06 commit f7cfbba
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 2 deletions.
19 changes: 19 additions & 0 deletions doc/source/_templates/autosummary/no_methods_doc/base.rst.jinja2
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{{ objname | escape | underline}}

.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}

{% block attributes %}
{% if attributes %}
.. rubric:: {{ _('Attributes') }}

.. autosummary::
:toctree:
{% for item in attributes %}
{% if item not in inherited_members %}
{{ name }}.{{ item }}
{% endif %}
{%- endfor %}
{% endif %}
{% endblock %}
1 change: 1 addition & 0 deletions doc/source/api/constants.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Constants

.. autosummary::
:toctree: _autosummary
:template: autosummary/no_methods_doc/base.rst.jinja2

FailureOutput
Spot
Expand Down
8 changes: 6 additions & 2 deletions doc/source/api/layup_info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@ General features to access information on the composite lay-up.
AnalysisPlyInfoProvider
ElementInfoProvider
ElementInfo
LayerProperty
LayupPropertiesProvider

:template: autosummary/no_methods_doc/base.rst.jinja2
LayerProperty
LayupProperty
LayupModelContextType

Expand All @@ -39,10 +41,12 @@ example shows how to evaluate material properties.
.. autosummary::
:toctree: _autosummary

MaterialProperty
get_constant_property
get_all_dpf_material_ids
get_constant_property_dict
:template: autosummary/no_methods_doc/base.rst.jinja2
MaterialProperty



Material operators
Expand Down

0 comments on commit f7cfbba

Please sign in to comment.