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

Improve automatically generated docs #990

Closed
3 tasks done
kristiankyvik opened this issue Jan 24, 2024 · 1 comment
Closed
3 tasks done

Improve automatically generated docs #990

kristiankyvik opened this issue Jan 24, 2024 · 1 comment
Assignees
@kristiankyvik
Labels
documentation Improvements or additions to documentation triage Interesting but stale issue. Will be close if inactive for 3 more days after label added.

Comments

@kristiankyvik
Copy link
Collaborator

kristiankyvik commented Jan 24, 2024 •
edited by similato87
Loading

Suggested steps:

  • Ensure Sphinx is correctly parsing the docstrings - PR for this one is here
  • Make sure that most important classes are correctly documented and have examples - PR for this one here
  • Review the static documentation files to clean/remove the ones that we cannot keep up to date - PR for this one here

@ATheorell does this makes sense to you? Happy to open PRs for each
@kristiankyvik kristiankyvik added documentation Improvements or additions to documentation triage Interesting but stale issue. Will be close if inactive for 3 more days after label added. labels Jan 24, 2024
This was referenced Jan 25, 2024
Merged
Merged
@kristiankyvik kristiankyvik mentioned this issue Feb 1, 2024
Closed
@kristiankyvik kristiankyvik mentioned this issue Feb 23, 2024
Merged
@kristiankyvik
Copy link
Collaborator Author

This can be closed as the last of the three PRs has been merged.

I created a new issue to address the docs broken build step.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kristiankyvik kristiankyvik

Labels
documentation Improvements or additions to documentation triage Interesting but stale issue. Will be close if inactive for 3 more days after label added.
Projects
gpt-engineer roadmap
Status: Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kristiankyvik