[
https://issues.apache.org/jira/browse/AVRO-3107?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17408789#comment-17408789
]
Ryan Skraba commented on AVRO-3107:
-----------------------------------
There's some interesting stuff going on at https://nightlies.apache.org to have
the current SNAPSHOT documentation from github actions (see Flink for example).
Currently, building and publishing the docs is a release task. All that really
needs to be done is for the python {{build.sh dist}} to put the generated HTML
in {{build/avro-doc-${VERSION}/api/py}} (like C# does
[here|https://github.com/apache/avro/blob/c175a63b64ee5440a906ad9dcbd298334c2c2555/lang/csharp/build.sh#L66]
for example).
> 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)
