feat: add pydoc action for readme

[ArzelaAscoIi]

Related Issues

• add pydoc auto sync for readme io
• ticket: https://github.com/deepset-ai/haystack-hub-api/issues/3118

Proposed Changes?

• generate pydoc markdown
• push pydoc markdown to readme io

Notes for the reviewer

Open todos:

• create sections /("slugs" ?) in readme that are synced
• version control always overwrites to the latest version

Checklist

• [ ] I have updated the referenced issue with new insights and changes
• [ ] If this is a code change, I have added unit tests
• [ ] I've used the conventional commit specification for my PR title
• [ ] I updated the docstrings
• [ ] If this is a code change, I added meaningful logs and prepared Datadog visualizations and alerts

[github-actions[bot]]

Coverage report

The coverage rate went from 96% to 96% :arrow_up: The branch rate is 86%.

100% of new lines are covered.

[rjanjua]

is there somewhere we can see the end result?

[ArzelaAscoIi]

is there somewhere we can see the end result?

Didn't check this on readme, but you can run the script locally and check the output in the tmp folder. @agnieszka-m checked it on readme side

[ArzelaAscoIi]

Here is a test run: https://github.com/deepset-ai/deepset-cloud-sdk/actions/runs/5331686232/jobs/9659864944