-
Notifications
You must be signed in to change notification settings - Fork 0
Description
While the documentation for Digikey JSON API is available at https://developer.digikey.com/products
the swagger generated python client API's don't have an easy accessible set of documents to compliment this
The swagger codegen does document all the classes and methods as per the Swagger API definition files and does pythonize all calls.
These documentation in code are as per standard practice and can be retrieved with standard python __doc__ calls
import digikey_productinformation as dPI
print(dPI.PartSearchApi.keyword_search.__doc__)A set of documentation for the current Stable https://github.com/auphofBSF/community-digikey-api-codegen-python-clients should be able to be generated in a format for hosting on https://readthedocs.org
This should be part of the when the Swagger CodeGen is executed, that the sphinx document generator is run. This repo should have an automated test and and automatic upload to readthedocs for the latest stable Build.
PR's welcomed