pyresample icon indicating copy to clipboard operation
pyresample copied to clipboard

dunder methods missing from readthedocs API

Open gerritholl opened this issue 2 years ago • 1 comments

The AreaDefinition methods support several special methods, for which documentation is missing on readthedocs. The most relevant ones for the user are __contains__, __eq__, and __getitem__.

I think there's a sphinx setting to control whether those are generated with API docs or not.

Problem description

Most users get their documentation from readthedocs. From the API documentation, one wouldn't it's possible (or should be) to check if a certain lat/lon is contained inside an area definition, despite this feature being potentially quite useful.

Versions of Python, package at hand and relevant dependencies

Current pyresample / online docs.

gerritholl avatar Nov 09 '21 17:11 gerritholl

https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-option-automodule-special-members

djhoese avatar Nov 09 '21 17:11 djhoese