Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add Python autodocs #1703

Merged
merged 13 commits into from
Sep 5, 2024
Merged

feat: add Python autodocs #1703

merged 13 commits into from
Sep 5, 2024

Conversation

sarahwooders
Copy link
Collaborator

@sarahwooders sarahwooders commented Aug 30, 2024 •
edited
Loading

Adds Google style docstrings to important classes that we want documented. Also adds a script for generating markdown files for auto-documented classes:

python docs/generate_docs.py

cpacker
cpacker requested changes Sep 3, 2024
View reviewed changes
Copy link
Owner

@cpacker cpacker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you merge in main and rerun poetry add? looks like there's a conflict due to the recent addition of jinja2

@cpacker cpacker self-requested a review September 5, 2024 18:55
@cpacker cpacker merged commit 5b88d2e into main Sep 5, 2024
12 checks passed
@cpacker cpacker deleted the refactor-autodocs branch September 5, 2024 18:55
@cpacker cpacker mentioned this pull request Sep 5, 2024
Closed
mattzh72 pushed a commit that referenced this pull request Oct 9, 2024
@sarahwooders
feat: add Python autodocs (#1703)
230cb68
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cpacker cpacker cpacker approved these changes

Assignees
No one assigned
Labels
None yet
Projects
🐛 MemGPT issue tracker
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sarahwooders @cpacker