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

Optimize the structure of Sphinx API doc #162

Merged
merged 3 commits into from
Apr 17, 2024
Merged

Optimize the structure of Sphinx API doc #162

merged 3 commits into from
Apr 17, 2024

Conversation

pan-x-c
Copy link
Collaborator

@pan-x-c pan-x-c commented Apr 17, 2024 •
edited
Loading

Description

  1. Use a custom .rst template to generate package documents automatically
  2. Optimize the structure of the package document

Note: From now on, only classes and functions that appear in __all__ of __init__.py will be added to the API documentation

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 self-assigned this Apr 17, 2024
@pan-x-c pan-x-c added documentation Improvements or additions to documentation ready for review labels Apr 17, 2024
yxdyc
yxdyc approved these changes Apr 17, 2024
View reviewed changes
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 e700472 into modelscope:main Apr 17, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yxdyc yxdyc yxdyc approved these changes

Assignees

@pan-x-c pan-x-c

Labels
documentation Improvements or additions to documentation ready for review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@pan-x-c @yxdyc