Skip to content

Update the documentation template to show class attributes #2402

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Mar 11, 2023
Merged

Update the documentation template to show class attributes #2402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
66395f8
Update the documentation template to show class attributes
seisman Mar 7, 2023
047d233
Remove attribute list from GMTDataArrayAccessor
seisman Mar 7, 2023
b4c5e1a
typo
seisman Mar 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/_templates/autosummary/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@

.. autoclass:: {{ objname }}

{% if attributes %}
.. rubric:: Attributes

{% for item in attributes %}
.. autoproperty::
{{ objname }}.{{ item }}
{% endfor %}
{% endif %}

{% if methods != ["__init__"] %}
.. rubric:: Methods Summary

Expand Down
9 changes: 0 additions & 9 deletions pygmt/accessors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,6 @@ class GMTDataArrayAccessor:
properties about grids, which are important for PyGMT to correctly process
and plot the grids.

Attributes
----------

registration : int
Registration type of the grid, either 0 (Gridline) or 1 (Pixel).
gtype : int
Coordinate system type of the grid, either 0 (Cartesian) or 1
(Geographic).

Notes
-----

Expand Down