From f7cfbba25a5825c141663c77e5a3fd9117603176 Mon Sep 17 00:00:00 2001 From: jvonrick Date: Fri, 10 May 2024 11:41:34 +0200 Subject: [PATCH] Don't generate docs for derived properties for enums --- .../no_methods_doc/base.rst.jinja2 | 19 +++++++++++++++++++ doc/source/api/constants.rst | 1 + doc/source/api/layup_info.rst | 8 ++++++-- 3 files changed, 26 insertions(+), 2 deletions(-) create mode 100644 doc/source/_templates/autosummary/no_methods_doc/base.rst.jinja2 diff --git a/doc/source/_templates/autosummary/no_methods_doc/base.rst.jinja2 b/doc/source/_templates/autosummary/no_methods_doc/base.rst.jinja2 new file mode 100644 index 000000000..b4d3fbc98 --- /dev/null +++ b/doc/source/_templates/autosummary/no_methods_doc/base.rst.jinja2 @@ -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 %} \ No newline at end of file diff --git a/doc/source/api/constants.rst b/doc/source/api/constants.rst index 0a5289a30..5356dbd46 100644 --- a/doc/source/api/constants.rst +++ b/doc/source/api/constants.rst @@ -5,6 +5,7 @@ Constants .. autosummary:: :toctree: _autosummary + :template: autosummary/no_methods_doc/base.rst.jinja2 FailureOutput Spot diff --git a/doc/source/api/layup_info.rst b/doc/source/api/layup_info.rst index f51ca18bb..3d613ee71 100644 --- a/doc/source/api/layup_info.rst +++ b/doc/source/api/layup_info.rst @@ -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 @@ -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