Actions
Documentation #19238
openlibrados python binding reference is not autogenerated
Status:
New
Priority:
Normal
Assignee:
-
Category:
documentation
Target version:
-
% Done:
0%
Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:
Description
The reference section should be generated from the docstrings, just like librbd's python docs are:
https://raw.githubusercontent.com/ceph/ceph/master/doc/rbd/librbdpy.rst
vs.
https://raw.githubusercontent.com/ceph/ceph/master/doc/rados/api/python.rst
Updated by Sebastian Wagner about 5 years ago
One problem is the lack of proper structure within the librados python API itself. Just autogenerating the doc doesn't make it readable, unfortunately.
Another problem is the lack of proper (or a lot of) docstrings.
Actions