[AVRO-3107] Python API documentation isn't available

• Type: New Feature
• Status: Resolved
• Priority: Major
• Resolution: Duplicate
• Component/s: doc, python
• Assignee: Unassigned
• Reporter: Spencer Nelson
• Created: 08/Apr/21 22:11
• Updated: 02/Sep/21 12:53
• Resolved: 02/Sep/21 12:53

Description

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.

Issue Links

• duplicates: AVRO-312 Generate documentation for Python with Sphinx