feature: API Documentation #201
Description
Component
Python SDK
Describe the Feature Request
It would be good to start publishing the documentation of the API for the Python SDK to help users understand the method available and the different options.
To ensure that the API documentation is always up to date, we need to :
- Dynamically generate it from the docstring of each method
- Define a convention for our docstring
- Enable some rules (D & DOC in Ruff) to validate the presence and the format of our docstring
- Enable some step in CI to validate that the API doc is up to date.
- Finish the migration of the doc to this repo task: Migrate documentation #51
Not all methods have a docstring today but this shouldn't stop us from setting up the API doc.
Describe the Use Case
Improve the developer experience when using the Python SDK and make it was easy as possible to interact with Infrahub programmatically
Additional Information
There are a few libraries available around documentation
pdoc looks like a good candidate to generate the API doc but not sure how well it integrates with docusaurus