You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@avro.apache.org by "Cristopher Ewing (Jira)" <ji...@apache.org> on 2021/07/08 16:53:00 UTC

[jira] [Comment Edited] (AVRO-3107) Python API documentation isn't available

    [ https://issues.apache.org/jira/browse/AVRO-3107?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17377500#comment-17377500 ] 

Cristopher Ewing edited comment on AVRO-3107 at 7/8/21, 4:52 PM:
-----------------------------------------------------------------

I would absolutely contribute to this.  Sphinx is a great choice, and now that there is a really decent [markdown parser]([https://myst-parser.readthedocs.io/en/latest/]), the barrier to entry for creating and maintaining Sphinx docs has never been lower.


was (Author: cewing):
I would absolutely contribute to this.  Sphinx is a great choice, and now that there is a really decent [markdown parser|[https://myst-parser.readthedocs.io/en/latest/], the barrier to entry for creating and maintaining Sphinx docs has never been lower.

> Python API documentation isn't available
> ----------------------------------------
>
>                 Key: AVRO-3107
>                 URL: https://issues.apache.org/jira/browse/AVRO-3107
>             Project: Apache Avro
>          Issue Type: New Feature
>          Components: doc, python
>            Reporter: Spencer Nelson
>            Priority: Major
>
> It's entirely possible that I'm missing something, but I can't find documentation for the Python API.
>  
> It used to exist, long ago; I can find docs for version 1.2.0 and earlier:
>  * [https://avro.apache.org/docs/1.2.0/api/py/avro.io.html]
>  * [https://avro.apache.org/docs/1.0.0/api/py/avro.io.html]
> But that link pattern stops working for 1.3+. Now there doesn't appear to be full documentation of the Python API. There's a brief and informal "getting started guide" ([https://avro.apache.org/docs/current/gettingstartedpython.html)] but it isn't very thorough, and doesn't explain which parts of the published modules are covered by any API stability.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)