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

API Documentation with sphinx #111

Closed
knwng opened this issue May 27, 2021 · 2 comments
Closed

API Documentation with sphinx #111

knwng opened this issue May 27, 2021 · 2 comments
Labels
community Source: who proposed the issue type/enhancement Type: make the code neat or more efficient

Comments

@knwng
Copy link
Contributor

knwng commented May 27, 2021

Hello everyone, do you have plan to provide API documentation? Maybe just something generated by sphinx like this http://supervisord.org/. I'm willing to help if that's in your roadmap.
@wey-gu
Copy link
Contributor

wey-gu commented May 27, 2021

This is a quite good idea, and we will also for sure benefit from the outcome when __doc__ are being added in a way that makes sphinx happy.
We may need to align with doc teams as it requires also hooks and places to host sphinx-generated contents.

What do you think please? @laura-ding @whitewum
Maybe we could further do similar things for all util labs?

@Sophie-Xie Sophie-Xie added type/enhancement Type: make the code neat or more efficient community Source: who proposed the issue labels Sep 28, 2021
@wey-gu
Copy link
Contributor

wey-gu commented Sep 25, 2023

done with #286

@wey-gu wey-gu closed this as completed Sep 25, 2023
@wey-gu wey-gu changed the title API Documentation request API Documentation with sphinx Sep 25, 2023
@wey-gu wey-gu mentioned this issue Sep 30, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
community Source: who proposed the issue type/enhancement Type: make the code neat or more efficient
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@wey-gu @knwng @Sophie-Xie