[
https://issues.apache.org/jira/browse/ARROW-16123?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17517459#comment-17517459
]
Joris Van den Bossche commented on ARROW-16123:
-----------------------------------------------
See
https://stackoverflow.com/questions/5599254/how-to-use-sphinxs-autodoc-to-document-a-classs-init-self-method
for some options. Either using {{"autodoc-skip-member"}} event or with
overriding the "special-members" default option
(https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_default_options),
it seems this should be possible.
> [Python] Do no include __init__ in the API documentation
> --------------------------------------------------------
>
> Key: ARROW-16123
> URL: https://issues.apache.org/jira/browse/ARROW-16123
> Project: Apache Arrow
> Issue Type: Improvement
> Components: Documentation, Python
> Reporter: Joris Van den Bossche
> Priority: Major
>
> From https://github.com/apache/arrow/pull/12698#discussion_r836484176
> We should try to instruct sphinx/autodoc/numpydoc to not include
> {{\_\_init\_\_}} functions in the reference docs, as I don't think we have
> any case where this adds value (compared to the class docstring). See eg
> https://arrow.apache.org/docs/dev/python/generated/pyarrow.parquet.ParquetDataset.html#pyarrow.parquet.ParquetDataset.__init__
> cc [~alenkaf]
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
