e2b-dev / E2B

Secure open source cloud runtime for AI apps & AI agents

https://e2b.dev/docs

Apache License 2.0

7.02k stars 458 forks source link

Auto-generate API reference markdown files for the python-sdk #441

Closed 0div closed 1 month ago

0div commented 2 months ago

Description

Installed and configured pydoc-markdown.
Created a script that generates and cleans markdown files with a configurable package list.
Added docstrings to relevant public methods of the various sdk classes in order for pydoc to detect them.

Test

cd packages/python-sdk
./scripts/generate_api_ref.sh 
ls ./api_ref

Considerations

This could eventually be used directly as .mdx in the docs nextjs app, it would look like this with current styling:

changeset-bot[bot] commented 2 months ago

⚠️ No Changeset found

Latest commit: 32b302f0a92978fca410ae53c74414f35dabcd42

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR