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.

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

[DOC] add API reference documentation #7

Merged
merged 4 commits into from
Jan 15, 2024

Conversation

pan-x-c
Copy link
Collaborator

@pan-x-c pan-x-c commented Jan 15, 2024


name: [DOC] add API reference documentation

Description

  1. add sphinx doc scripts
  2. add README on how to build the doc
  3. add a GitHub workflow to build the doc automatically

Checklist

Please check the following items before code is ready to be reviewed.

  • Code has passed all tests
  • Docstrings have been added/updated in Google Style
  • Documentation has been updated
  • Code is ready for review

@pan-x-c pan-x-c requested review from yxdyc and DavdGao January 15, 2024 09:46
@pan-x-c pan-x-c self-assigned this Jan 15, 2024
@pan-x-c pan-x-c added the documentation Improvements or additions to documentation label Jan 15, 2024
Copy link
Collaborator

@yxdyc yxdyc left a comment

Choose a reason for hiding this comment

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

LGTM

@pan-x-c pan-x-c merged commit 06929d7 into modelscope:main Jan 15, 2024
4 checks passed
FredericW pushed a commit to FredericW/agentscope that referenced this pull request Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants