Skip to content

doc: fix docs issues #1094

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

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from
1 change: 1 addition & 0 deletions doc/changelog.d/1093.miscellaneous.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Increase pr deployed docs
1 change: 1 addition & 0 deletions doc/changelog.d/1094.miscellaneous.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Doc: fix docs issues
11 changes: 8 additions & 3 deletions doc/source/_templates/autosummary/class.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
.. vale off

{% set excluded_attrs = ['real', 'imag', 'numerator', 'denominator'] %}

{% set excluded_methods = ['bit_length', 'conjugate', 'from_bytes', 'to_bytes', 'bit_count', 'as_integer_ratio', 'is_integer'] %}

{{ name | escape | underline}}

.. currentmodule:: {{ module }}
Expand All @@ -12,8 +16,9 @@

.. autosummary::
:toctree:

{% for item in methods %}
{% if item != '__init__' %}{{ name }}.{{ item }}{% endif %}
   {% if item != '__init__' %}{{ name }}.{{ item }}{% endif %}
{%- endfor %}
{% endif %}
{% endblock %}
Expand All @@ -25,7 +30,7 @@
.. autosummary::
:toctree:
{% for item in attributes %}
{{ name }}.{{ item }}
{% if item not in excluded_attrs %}{{ name }}.{{ item }}{% endif %}
{%- endfor %}
{% endif %}
{% endblock %}
Expand All @@ -35,4 +40,4 @@

{{ fullname }}

.. vale on
.. vale on
1 change: 1 addition & 0 deletions doc/source/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ This section gives an overview of all API classes, methods, and parameters prese

ansys.meshing.prime
ansys.meshing.prime.examples
ansys.meshing.prime.graphics
ansys.meshing.prime.lucid
Loading